v1

latestOpenAPI 3.0.12026-07-13139143370.4 KB

Services

List Service Allocations

Use this endpoint to return a List of Service Allocations for a specified service. A valid service id is required. Service allocations are used for Event type services only where the events are offered on specific dates and times. Retrieve all allocations for a location by passing in 0 as the service id.

The results are returned in pages. 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.

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

Path parameters

idstring required

id of service to list allocations for, 0 for all

Query parameters

locationIdstring

The id of the location. Defaults to the primary location

resourceIdstring

The id of the resource to filter on

startDatestring date-time

Format YYYY-MM-DD. Filter appointments by on/after startDate

endDatestring date-time

Format YYYY-MM-DD. Filter appointments 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