Quote the price of a given shift

POST 
/api/v2/public/marketplace/shifts/quote

General Information

Although a price quoting is calculated when creating shifts, we provide a price quotation without creating a shift.

This will not create a shift, but you can create one from the quote. The shift quote is calculated based on the from, to, and breakTime parameters.

Note: The quote is temporarily stored for 15 minutes. After that, it can no longer be used.

Request

application/json

Body

required

facilityId stringrequired

Id of the Facility

shift objectrequired

licenseType stringrequired

License Type of the shift

description stringrequired

Description of the shift, you can provide detailed information about the shift, it can include any relevant details that would help nurses understand the nature and requirements of the shift.

from date-timerequired

Shift start date

to date-timerequired

Shift end date, must be less than 24 hours after from field

breakTime ISO 8601 duration

Break Time for the shift

Responses

201

application/json

Schema

Schema

data object

quoteId stringrequired

Shift QuoteId

billRatePerHour numberrequired

Price per hour

totalAmount numberrequired

Total price

expiresAt date-timerequired

Quote expiration date

breakTime ISO 8601 duration

Break Time for the shift

Example (from schema)

{
  "data": {
    "quoteId": "00eaf2d1-515b-4ab9-9632-4308b9c2c0cc",
    "billRatePerHour": 47.5,
    "totalAmount": 178.8,
    "expiresAt": "2024-09-13T18:48:23.280Z",
    "breakTime": "PT45M"
  }
}

400

Bad request

application/json

Schema

Schema

message string[]

Error description

error string

The type of error

statusCode integer

Status code of the error

Example (from schema)

{
  "message": [
    "Property must be a string"
  ],
  "error": "Bad Request",
  "statusCode": 400
}

Request Validation

Request Validation Error

{
  "message": [
    "facilityId must be a string",
    "licenseType should not be empty",
    "licenseType must be a string",
    "description should not be empty",
    "description must be a string",
    "from must be RFC 3339 date",
    "from must be a valid ISO 8601 date string",
    "from should not be empty",
    "to must be RFC 3339 date",
    "to must be less than 24 hours after from field",
    "to must be a valid ISO 8601 date string",
    "to should not be empty"
  ],
  "error": "Bad Request",
  "statusCode": 400
}

401

Unauthorized

application/json

Schema

Schema

message string

Error description

statusCode integer

Status code of the error

Example (from schema)

{
  "message": "Unauthorized",
  "statusCode": 401
}

403

Forbidden

application/json

Schema

Schema

message string

Error description

error string

The type of error

statusCode integer

Status code of the error

Example (from schema)

{
  "message": "Forbidden Resource",
  "error": "Forbidden",
  "statusCode": 403
}

Loading...