Accept clinician's shift report

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

General Information

Accepts the Clinician's shift report

When a facility user accepts the clinician's shift report, they are agreeing with the information provided by the clinician. Therefore, no intervention from Nursa employees will be necessary.

You can use the Get Shift Report endpoint verify if the clinician's shift report is correctIf you believe the report contains incorrect information, you can use the Reject Shift Report endpoint to submit the correct values.

Request

Path Parameters

shiftId stringrequired
Nursa ShiftId
Example: 8222234296

application/json

Body

required

comment stringrequired

A comment about the clinician

rate numberrequired

Possible values: >= 1 and <= 5

Rate the clinician from 1 to 5

Responses

201

application/json

Schema

Schema

data object

from date-timerequired

Shift start date

to date-timerequired

Shift end date

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

comment stringrequired

Comment of the shift

bonus numberrequired

Bonus to be paid to Clinician

reportType stringrequired

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

Type of the report

breakTime ISO 8601 duration

Break Time for the shift

updateDate date-timerequired

The date the shift was last updated

totalAmount numberrequired

Total price of the shift

reviewComment numberrequired

Comment reviewing the Clinician

rate numberrequired

Rate given to Clinician

Example (from schema)

{
  "data": {
    "from": "2024-10-04T18:30:16.310Z",
    "to": "2024-10-04T18:30:16.310Z",
    "cancelationReason": "Nurse",
    "cancelationComment": "Excused Emergency",
    "comment": "Everything was fine :)",
    "bonus": 2.5,
    "reportType": "Nurse",
    "breakTime": "PT45M",
    "updateDate": "2024-10-04T18:30:16.311Z",
    "totalAmount": 178.8,
    "reviewComment": "A comment",
    "rate": 5
  }
}

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",
    "rate must not be greater than 5",
    "rate must not be less than 1",
    "rate must be an integer number"
  ],
  "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...