Get marketplace shifts

GET 
/api/v2/public/marketplace/shifts

General Information

This endpoint returns shifts for the facilities that user is connected to.

Request

Query Parameters

limit number
Possible values: <= 100
Default value: 10
Pagination parameter, use to specify the quantity of records returned
Example: 10
offset number
Default value: 0
Pagination parameter, use to specify the number of records to skip before starting to return results
Example: 10
sortDirection string
Possible values: [ASC, DESC]
Default value: DESC
Pagination parameter, use to specify the order of records by creation date, either 'asc' for ascending or 'desc' for descending
Example: DESC
facilityId string
Id of the facility
Example: NUR-12345
startDateFrom date-time
When you provide date-time value, time is ignored and will take the start of the day for the given date (00:00:00). When startDateTo is provided this becomes mandatory
Example: 2024-09-13T18:48:23.366Z
startDateTo date-time
When you provide date-time value, time is ignored and will take end of the day for given date (23:59:59)
Example: 2024-09-13T18:48:23.366Z
shiftId string
Id of the shift
Example: 5552536398

Responses

201

application/json

Schema

Schema

data object[]
Array [
shiftId stringrequired
Id of the shift
facilityId stringrequired
Id of the Facility
from date-timerequired
Shift start date
to date-timerequired
Shift end date
licenseType stringrequired
License Type of the shift
status stringrequired
Status of the Shift
breakTime ISO 8601 duration
Break Time for the shift
]
meta object

limit numberrequired

Number of items returned

offset numberrequired

Starting position

sortDirection objectrequired

Sorting direction

total numberrequired

Total records found

Example (from schema)

{
  "data": [
    {
      "shiftId": "12120878",
      "facilityId": "NUR-0879",
      "from": "2024-09-13T18:48:24.361Z",
      "to": "2024-09-13T18:48:24.361Z",
      "licenseType": "RN",
      "status": "Requested",
      "breakTime": "PT45M"
    }
  ],
  "meta": {
    "limit": 0,
    "offset": 0,
    "sortDirection": {},
    "total": 0
  }
}

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": [
    "limit must be a number conforming to the specified constraints",
    "limit must not be less than 0",
    "limit must not be greater than 50",
    "offset must be a number conforming to the specified constraints",
    "offset must not be less than 0",
    "sortDirection must be one of the following values: ASC, DESC",
    "facilityId must be a string",
    "startDateFrom must be a date before startDateTo",
    "startDateFrom must be a valid ISO 8601 date string",
    "startDateTo must be a valid ISO 8601 date string",
    "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...