Get Facility Work History
GET/api/v2/public/facilities/:facilityId/work-history
Return data of clinicians that have completed a shift for the given Facility.
The data will be sorted based on the Shift Start Date.
Request
Path Parameters
Id of the facility
Query Parameters
Possible values: <= 100
Default value: 10
Pagination parameter, use to specify the quantity of records returned
Default value: 0
Pagination parameter, use to specify the number of records to skip before starting to return results
Possible values: [ASC
, DESC
]
Default value: DESC
Pagination parameter, use to specify the order of records by creation date, either 'asc' for ascending or 'desc' for descending
Responses
- 201
- 400
- 401
- 403
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
data object[]
Id of the Clinician
First Name of the Clinician
Last Name of the Clinician
Indicates if the Clinician is favorited
The date of the last shift worked by the Clinician
{
"data": [
{
"clinicianId": "I7002epLHLhBCypdPCrn9XP4kTN2",
"firstName": "Mary",
"lastName": "Jane",
"isFavorited": false,
"lastShiftDate": "2024-10-04T18:30:16.315Z"
}
]
}
Bad request
- application/json
- Schema
- Example (from schema)
- Request Validation
Schema
Error description
The type of error
Status code of the error
{
"message": [
"Property must be a string"
],
"error": "Bad Request",
"statusCode": 400
}
Request Validation Error
{
"message": [
"facilityId must be a string"
],
"error": "Bad Request",
"statusCode": 400
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
Error description
Status code of the error
{
"message": "Unauthorized",
"statusCode": 401
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
Error description
The type of error
Status code of the error
{
"message": "Forbidden Resource",
"error": "Forbidden",
"statusCode": 403
}