Create shifts

POST 
/api/v2/public/marketplace/shifts/batch

General Information

When creating shift price quotation is based on from, to dates, and optional breakTime params.

• Failure: The process uses transactions, so if one job fails, all changes are reverted.
• License Requirement: A valid licenseType must be provided when creating a shift.
• Facility Connection: If the authenticated user is not connected with the facility, the system will return a "facility not found" error. In this case, refer to the facility connection request guide. Ensure you account for this response in your implementation.

Potential Issues

• No Associated User: There is no user associated with the facility. At least one user must be created and associated with the facility.
• No Associated User: The user needs to have a connection with the facility

Request

application/json

Body

required

facilityId stringrequired
shifts object[]required
Array [
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
autoScheduleEnabled boolean
If the facility has auto-scheduling feature enabled then this property can be set to false to disable auto-scheduling for this shift.
]

Responses

201

application/json

Schema

Schema

data object[]
Array [
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
]

Example (from schema)

{
  "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"
    }
  ]
}

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",
    "shifts must be an array"
  ],
  "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...