v1

latestOpenAPI 3.0.12026-07-133870165.8 KB
Services

List Service Allocations

Use this endpoint to return a List of Service Allocations associated with the requested service. A valid service id is required. Allocations are used for Event type services/bookings. Retrieve all allocations for a location by passing in zero as the service id. Otherwise, to get allocations for a specific service supply the service id. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further. For more information: Create Service Allocations

get/consumer/v1/services/{id}/allocations

Path parameters

idstring required

id of service to list allocations for, 0 for all

Query parameters

locationIdstring

id of the location, defaults to the primary location

resourceIdstring

id of the resource to filter on

startDatestring date-time

Format YYYY-MM-DD: Filter allocations on/after startDate

endDatestring date-time

Format YYYY-MM-DD. Filter allocations on/before endDate

offsetinteger

Starting row of page, default 0

limitinteger

Page limit default 20, max 100

Response

service alloaction object

objectstring nullable
urlstring nullable
hasMoreboolean
countinteger
totalinteger