Create shift from quote
POST/api/v2/public/marketplace/shifts/quote/:quoteId/shift
General Information
Based on previously created quote you can now create a shift.
If the facility for which you are creating the shift has the Auto Schedule feature enabled, the shifts will inherit the same Auto Schedule settings by default.
- To enable only specific Auto Schedule options, use the
autoScheduleSettings
property in the request body to specify the desired options. - To create a shift without any Auto Schedule options, even if the facility has this feature enabled, set
autoScheduleSettings
tonull
or an empty array ([]
).
Potential issues
- Quoted shift not found Quote has expired
- Auto schedule option is not enabled for this facility The facility for which you are creating the shift does not have the specified Auto Schedule option enabled
Request
Path Parameters
quoteId stringrequired
Shift QuoteId
Example: 86137ed9-b78d-4b8d-96f0-d63a6296a60b
Responses
- 201
- 400
- 401
- 403
- 404
- application/json
- Schema
- Example (from schema)
Schema
data object
shiftId stringrequired
Id of the shift
facilityId stringrequired
Id of the Facility
description stringrequired
Description of the Shift
from date-timerequired
Shift start date
to date-timerequired
Shift end date
licenseType stringrequired
License Type of the shift
price objectrequired
billRatePerHour numberrequired
Price per hour
totalAmount numberrequired
Total price
createdBy string
Id of the user that created the shift
breakTime ISO 8601 duration
Break Time for the shift
{
"data": {
"shiftId": "12120878",
"facilityId": "NUR-0879",
"description": "Must take 30 minute break",
"from": "2022-09-13T00:00:00.000Z",
"to": "2022-09-14T00:00:00.000Z",
"licenseType": "RN",
"price": {
"billRatePerHour": 47.5,
"totalAmount": 178.8
},
"createdBy": "gsFu59GrbAhFmUB0QyYf1Ubg0Q5E",
"breakTime": "PT45M"
}
}
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": [
"quoteId 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)
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
}
Not Found
- application/json
- Schema
- Example (from schema)
- Quote Not Found
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
}
Quote was not found
{
"message": "Quoted shift not found",
"error": "Not Found",
"statusCode": 404
}
Loading...