Change an existing provider's work history info

Change an existing work history info associated with the specified provider.

Request
path Parameters
providerId
required
string <uuid>
id
required
string <uuid>
Request Body schema: application/json
workHistoryType
string

Gap identifies a time period when this provider was not employed

Enum: "Employment" "Gap"
name
string

Name or employer

jobTitle
string

Job title while working for this employer

object (ProviderAddressModel)
phone
string

Employer phone number

startDate
string <date-time>

Timestamp when this provider started working for the employer

endDate
string <date-time>

Timestamp when this provider finished working for the employer

isCurrentEmployer
boolean

Identifies if the provider is currently employed by the employer

departureReason
string

Reason provider left this employer

gapExplanation
string

If work history type is set to Gap provider must explain reason for the gap in employment

Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

patch/providers/{providerId}/info/workHistory/{id}
Request samples
application/json
{
  • "workHistoryType": "Employment",
  • "name": "string",
  • "jobTitle": "string",
  • "address": {
    },
  • "phone": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "isCurrentEmployer": true,
  • "departureReason": "string",
  • "gapExplanation": "string"
}
Response samples
application/json
{
  • "lastUpdatedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "workHistoryType": "Employment",
  • "name": "string",
  • "jobTitle": "string",
  • "address": {
    },
  • "phone": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "isCurrentEmployer": true,
  • "departureReason": "string",
  • "gapExplanation": "string"
}