Schedule clinician to a shift

POST 
/api/v2/public/scheduled-shifts

Schedule a clinician to a shift.

After a shift is created, and a clinician requests it, you can use the Get requested shifts endpoint to check the clinicians who requested to work the shift. Additionally, you can Download the Clinician Profile to help you choose which clinician best fits the shift.

Users can also create a Webhook in our system to receive notifications when the a clinician requests to work a shift.

Request

application/json

Body

required

shiftId stringrequired

Id of the shift

clinicianId stringrequired

Id of the clinician

Responses

201

application/json

Schema

Schema

data object

facilityId stringrequired

Id of the Facility

shiftId stringrequired

Id of the shift

from date-timerequired

Shift start date

to date-timerequired

Shift end date

licenseType stringrequired

License Type of the shift

clinician objectrequired

id stringrequired

Id of the clinician

firstName stringrequired

First name of the clinician

lastName stringrequired

Last name of the clinician

contactEmail stringrequired

Email of the clinician

contactPhone +1##########required

Contact Phone of the clinician

scheduledBy string

Id of the user that scheduled the shift

breakTime ISO 8601 duration

Break Time for the shift

Example (from schema)

{
  "data": {
    "facilityId": "NUR-123456",
    "shiftId": "4765568640",
    "from": "2024-09-13T00:00:00.000Z",
    "to": "2024-09-14T00:00:00.000Z",
    "licenseType": "RN",
    "clinician": {
      "id": "I7002epLHLhBCypdPCrn9XP4kTN2",
      "firstName": "Jane",
      "lastName": "Doe",
      "contactEmail": "jane@doe.com",
      "contactPhone": "+12345678910"
    },
    "scheduledBy": "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": [
    "shiftId must be a string",
    "clinicianId must be a string"
  ],
  "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
}

404

Not Found

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": "Not Found",
  "error": "Not Found",
  "statusCode": 404
}

Clinician Not available

Clinician is no longer available

{
  "message": "Clinician is no longer available",
  "error": "Not Found",
  "statusCode": 404
}

Shift Not Found

Shift not found

{
  "message": "Shift not found",
  "error": "Not Found",
  "statusCode": 404
}

Request Not Found

Shift request not found

{
  "message": "Shift request not found",
  "error": "Not Found",
  "statusCode": 404
}

Clinician Not Found

Clinician not found

{
  "message": "Clinician not found",
  "error": "Not Found",
  "statusCode": 404
}

Loading...