Maxxton External API

Sections

Get all doorlock pincodes for a unit

Query Parameters

endDatestring

If both startDate and endDate are provided, data will be fetched for the specified date range from startDate to endDate. If only the endDate is provided, pin codes will be returned from the currentDate until endDate, and the duration in between the currentDate and endDate should not be greater than one month.

startDatestring

If both startDate and endDate are provided, data will be fetched for the specified date range from startDate to endDate. If only the startDate is provided, pin codes will be returned from startDate until the next one month.

pageinteger

Page number

sizeinteger

Size of the current page

sortstring

Sort parameter

filterarray

Following fields can be used for filtering response.
doorlockId:0,
unitId:0,
lockCode:String,
codeLength:0,
bluetoothLowEnergy:trueFor 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 unit doorlock pincodes

GET

/

Select
1

Response