Reject clinician's shift report

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

General Information

Rejects the Clinician's shift report

If you believe the clinician's shift report contains incorrect information, you can reject it and submit the values you believe are correct. After your report is submitted, a Nursa employee will determine the correct information.

Request

Path Parameters

shiftId stringrequired
Nursa ShiftId
Example: 8222234296

application/json

Body

required

reviewComment stringrequired

Comment regarding the individual who worked on the shift

rate numberrequired

Possible values: >= 1 and <= 5

Rate the clinician from 1 to 5

breakTime ISO 8601 durationrequired
from date-timerequired
to date-timerequired
comment stringrequired

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

bonus number

monetary bonus to clinician

Responses

201

application/json

Schema

Schema

data object

breakTime ISO 8601 duration

Break Time for the shift

from date-timerequired

Shift end date

to date-timerequired

Shift start date

comment stringrequired

Comment about how the clinician worked the shift

completed booleanrequired

createdAt date-timerequired

Date the shift report was created

shiftId stringrequired

Id of the shift

reportType stringrequired

Possible values: [Nurse, Facility, Admin, AdminBilling]

Type of the report

totalAmount numberrequired

Total price

cancelationReason string

Possible values: [Facility, Nurse, On Hold, Other]

Cancelation Reason

cancelationComment string

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

Comment about the cancelation

Example (from schema)

{
  "data": {
    "breakTime": "PT45M",
    "from": "2024-09-13T18:48:24.359Z",
    "to": "2024-09-13T18:48:24.359Z",
    "comment": "All good, the clinician did a great job",
    "completed": true,
    "createdAt": "2024-09-13T18:48:24.359Z",
    "shiftId": "12120878",
    "reportType": "Facility",
    "totalAmount": 178.8,
    "cancelationReason": "Nurse",
    "cancelationComment": "Excused Emergency"
  }
}

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": [
    "reviewComment must be a string",
    "rate must not be greater than 5",
    "rate must not be less than 1",
    "rate must be an integer number",
    "breakTime must be a valid ISO 8601 duration (e.g., PT45M)",
    "from must be RFC 3339 date",
    "from must be a date before to",
    "from must be a valid ISO 8601 date string",
    "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",
    "comment must be a string",
    "bonus must not be less than 0",
    "bonus must be a number conforming to the specified constraints"
  ],
  "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...