Download clinician profile
GET/api/v2/public/downloads/clinician/:clinicianId/shift/:shiftId
Returns link to download detailed clinician profile for a shift.
Request
Path Parameters
shiftId stringrequired
Id of the shift
Example: 4603117571
clinicianId stringrequired
Id of the clinician
Example: lcFQMy1n0decDeZljQG2wUNZBru7
Responses
- 201
- 400
- 401
- 403
- 404
- application/json
- Schema
- Example (from schema)
Schema
data object
url stringrequired
{
"data": {
"url": "https://nursa.page.link/N9Bw"
}
}
Bad request
- application/json
- Schema
- Example (from schema)
- Request Validation
Schema
message string[]
Error description
error string
The type of error
statusCode integer
Status code of the error
{
"message": [
"Property must be a string"
],
"error": "Bad Request",
"statusCode": 400
}
Request Validation Error
{
"message": [
"shiftId must be a string",
"clinicianId must be a string"
],
"error": "Bad Request",
"statusCode": 400
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
message string
Error description
statusCode integer
Status code of the error
{
"message": "Unauthorized",
"statusCode": 401
}
Forbidden
- application/json
- Schema
- Example (from schema)
- Clinician did not Requested
Schema
message string
Error description
error string
The type of error
statusCode integer
Status code of the error
{
"message": "Forbidden Resource",
"error": "Forbidden",
"statusCode": 403
}
Clinician didn't requested this shift.
{
"message": "Clinician didn't requested this shift.",
"error": "Forbidden",
"statusCode": 403
}
Not Found
- application/json
- Schema
- Example (from schema)
- Not Ready
- Failed
- PDF Error
- Snapshot Error
Schema
message string
Error description
error string
The type of error
statusCode integer
Status code of the error
{
"message": "Not Found",
"error": "Not Found",
"statusCode": 404
}
Clinician profile is not ready
{
"message": "Clinician profile url is not available yet, try again later.",
"error": "Not Found",
"statusCode": 404
}
Failed to retrieve shift request
{
"message": "Failed to retrieve shift request",
"error": "Not Found",
"statusCode": 404
}
Error downloading the PDF
{
"message": "Error downloading the PDF",
"error": "Not Found",
"statusCode": 404
}
Failed to retrieve clinician profile snapshot url
{
"message": "Failed to retrieve clinician profile snapshot url",
"error": "Not Found",
"statusCode": 404
}
Loading...