List Resource Occupations

Request

Retrieve resource occupations that intersect a required time interval in a Location. Results can be narrowed to one or more Services.

Each JSON:API resource identifies the occupied resource instance, its time interval, and the source Appointment or Event.

Security

BearerPartnerUser

Path

location_idintegerrequired

Location ID

Query

filter[service_id]integer, >= 1

Filter by one Service ID

filter[service_ids][]Array of integers

Filter by multiple Service IDs

filter[date_intersect_from_strict]string^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$required

Interval start in the Location timezone, without an offset

filter[date_intersect_to_strict]string^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$required

Interval end in the Location timezone, without an offset

Acceptstringrequired

Required B2B v2 response media type. Use application/vnd.api.v2+json. A charset parameter is also accepted.

Default:"application/vnd.api.v2+json"

Example:application/vnd.api.v2+json

Authorizationstringrequired

Bearer {partner_token}, User {user_token}

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v2/openapi/locations/{location_id}/resource_occupations?filter%5Bservice_id%5D=1&filter%5Bservice_ids%5D%5B%5D=1&filter%5Bdate_intersect_from_strict%5D=string&filter%5Bdate_intersect_to_strict%5D=string' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>'

Responses

Resource occupations retrieved successfully

Bodyapplication/json

dataArray of objects(Resource Occupation Resource)required

Response

{
  "data": [
    { … }
  ]
}