UpdateLearner
PATCH /tp-api/learners/:learnerId
Patch a training provider learner.
Path Parameters
- learnerId string required
Training Provider Learner ID.
Header Parameters
- training-provider-id string required
- application/json
Request Body
- firstname string
Learner first name.
- lastname string
Learner last name.
- email email
Learner email
- phone string
Possible values: Value must match regular expression
^[1-9][0-9]{0,3} [0-9]{8,11}(x[0-9]+)?$
Learner phone number
Responses
- 200
- 400
Default Response
- application/json
- Schema
- Example (from schema)
Schema
- id string required
Learner ID.
- firstname string
Learner first name.
- lastname string
Learner last name.
- uniqueSystemIdentifier string
Learner unique system ID.
- email string
Learner email.
- phone string
Learner phone.
- created string
{
"id": "string",
"firstname": "string",
"lastname": "string",
"uniqueSystemIdentifier": "string",
"email": "string",
"phone": "string",
"created": "string"
}
Default Response
- application/json
- Schema
- Example (from schema)
Schema
- anyOf
- MOD1
- MOD2
statusCode number requiredcode stringError code
error string requiredError key
message string requiredError message
error object required
key string requiredError key
message string requiredError message
{
"statusCode": 0,
"code": "string",
"error": "string",
"message": "string"
}
Loading...