Elevator stops

Fetch elevator stops

get/elevator_stops

Request

  • Base URL
    https://api.kisi.io
  • URL
    https://api.kisi.io/elevator_stops
  • Auth
    • API key in header Authorization
    • or OAuth 2
      Authorization code: https://api.kisi.io/oauth/authorize
      Token URL: https://api.kisi.io/oauth/token

Query parameters

place_idinteger required

The ID of the place to scope by

idsstring

Filter by object IDs

elevator_idstring

Filter by elevator ID

floor_idinteger

Filter by floor ID

limitinteger

The number of objects to return

offsetinteger

The number of objects to offset

Response

OK

idinteger required

The ID of the elevator stop

resource_type'ElevatorStop' required

The resource type of the elevator stop

created_atstring date-time required

When the elevator stop was created

updated_atstring date-time required

When the elevator stop was updated

namestring required

The name of the elevator stop

locked_downboolean required

Whether the elevator stop is currently locked down. When locked down the elevator stop is locked for everyone

locked_down_sincestring date-time nullable required

Since when the elevator stop has been locked down

on_scheduled_permitboolean required

If the elevator stop is on a scheduled unlock

permittedboolean required

Whether the elevator stop is currently permitted

time_restriction_enabledboolean nullable required

Whether the elevator stop is time restricted. Time restriction enforces that users may only permit at specific hours

elevator_idinteger required

The elevator ID of the elevator stop

floor_idinteger required

The floor ID of the elevator stop

place_idinteger required

The place ID of the elevator stop

Changes

No recorded changes to this operation across all 9 revisions of this API.