Maxxton External API

Sections

Get all facilities

Query Parameters

openingTimeFromstring

The opening times of the facilities can be limited by requesting a start date. This will work only when returnOpeningTimes=true, and must be passed along with openingDateTo. The difference between openingTimeFrom and openingDateTo should not be greater than 31 days.

openingTimeTostring

The opening times of the facilities can be limited by requesting an end date. This will work only when returnOpeningTimes=true, and must be passed along with openingTimeFrom. The difference between openingTimeFrom and openingDateTo should not be greater than 31 days.

returnOpeningTimesboolean

Returns Facility opening times. By default, this request param is false, and should be used in the request opening times are expected. If this parameter is requested, only 10 facilities per page will be returned.

returnUnpublishedboolean

This will return unpublished Facility opening times.

pageinteger

Page number

sizeinteger

Size of the current page

sortstring

Sort parameter

filterarray

Following fields can be used for filtering response.
facilityId:0,
code:String,
internalUse:true,
locationId:0,
priority:0,
openingTimes:StringFor more information, check: Filtering

Response

200
Object
The request is completed successfully without any errors

Response Attributes

totalElementsinteger

Total number of elements available in the whole response.

totalPagesinteger

Total number of pages the response has.

sizeinteger

Size of the current page.

contentarray

Show child attributes

numberinteger

Page number currently accessed.

sortobject

Show child attributes

firstboolean

Boolean field to specify if its the first page or not.

lastboolean

Boolean field to specify if its the last page or not.

numberOfElementsinteger

Total number of elements in the current page.

emptyboolean
500
Object
Error occurred while fetching facilities.

GET

/

Select
1

Response