Cancel shift

POST 
/api/v2/public/marketplace/shifts/cancel/:shiftId

General Information

Canceling a shift affects the following shift statuses:

• Shift Open: shift.cancelled
• Shift Requested: shift.cancelled, shift.request.cancelled
• Shift Scheduled but Not Started: shift.cancelled, shift.scheduled.cancelled
• Shift Scheduled and In Progress: shift.cancelled, shift.scheduled.cancelled

Webhooks Configuration

To stay up to date with shift cancellations, configure the following webhooks: Webhooks API Documentation

• shift.cancelled
• shift.request.cancelled
• shift.scheduled.cancelled

Cancellation Reason

Possible reasons:

• Filled internally: The shift was filled by internal staff within the organization.
• Filled by other agency: The shift was filled by a clinician from another agency.
• Talent not needed: The shift is no longer required, possibly due to changes in demand or scheduling errors.

Request

Path Parameters

shiftId stringrequired
Nursa ShiftId
Example: 8222234296

application/json

Body

required

comment string

General comment about the cancelation of the shift

cancelationReason string

Possible values: [Filled internally, Filled by other agency, Talent not needed]

Reason why the shift is being canceled

Responses

201

application/json

Schema

Schema

data object

shiftId stringrequired

Id of the shift

status stringrequired

Status of the shift

facilityId stringrequired

Id of the shift's Facility

licenseType stringrequired

License Type of the shift

Example (from schema)

{
  "data": {
    "shiftId": "3502817654",
    "status": "Filled internally",
    "facilityId": "NUR-123456",
    "licenseType": "RN"
  }
}

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": [
    "comment must be a string",
    "cancelationReason must be one of the following values: Filled internally, Filled by other agency, Talent not needed"
  ],
  "error": "Bad Request",
  "statusCode": 400
}

Transition Status

Cannot transition job to a different status

{
  "message": "Cannot transition job from status Paid to CancelledFilledInternally",
  "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...