Cancel clinician's shift report

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

General Information

Cancel the Clinician's shift report

If the clinician didn't work the shift, you can cancel it. After the cancel shift report is sent, the status of the shift will be changed to Didn't Work

Additionally, if the cancellationComment chosen was No Longer Want to Work With This Clinician, the clinician will be blocked from making future shift requests to the facility where the shift was scheduled.

Request

Path Parameters

shiftId stringrequired
Nursa ShiftId
Example: 8222234296

application/json

Body

required

cancellationComment stringrequired

Possible values: [No Call No Show, Excused Emergency, Refused to Work, No Longer Want to Work With This Clinician]

Reason why the shift was canceled or the clinician was not able to complete the shift

comment string

General comment or feedback about the shift itself, including any incidents, issues, or noteworthy aspects

Responses

201

Empty Response

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": [
    "cancellationComment must be one of the following values: No Call No Show, Excused Emergency, Refused to Work, No Longer Want to Work With This Clinician",
    "comment must be a string"
  ],
  "error": "Bad Request",
  "statusCode": 400
}

Shift not Completed

Shift is not completed

{
  "message": "Shift must be completed to submit a shift report",
  "error": "Bad Request",
  "statusCode": 400
}

Already Submitted

Shift report already submitted

{
  "message": "Facility shift report already submitted",
  "error": "Bad Request",
  "statusCode": 400
}

Missing Clinician Report

Clinician shift report was not submitted

{
  "message": "Clinician shift report was not submitted",
  "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...