Get shift reports

GET 
/api/v2/public/marketplace/shifts/reports/:shiftId

General Information

Returns all the shift reports belonging to the Shift

Users can also create a Webhook in our system to receive notifications whenever a new shift report is created.

Request

Path Parameters

shiftId stringrequired
Nursa ShiftId
Example: 8222234296

Responses

201

application/json

Schema

Schema

data object[]
Array [
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
]

Example (from schema)

{
  "data": [
    {
      "from": "2024-09-13T18:48:23.284Z",
      "to": "2024-09-13T18:48:23.284Z",
      "cancelationReason": "Nurse",
      "cancelationComment": "Excused Emergency",
      "comment": "Everything was fine :)",
      "bonus": 2.5,
      "reportType": "Nurse",
      "breakTime": "PT45M",
      "updateDate": "2024-09-13T18:48:23.285Z",
      "totalAmount": 178.8
    }
  ]
}

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"
  ],
  "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...