Documentation Powered by ReDoc

IsItBusy API (1.0)

Download OpenAPI specification:Download

E-mail: developers@isitbusy.at URL: https://isitbusy.at/contact-us

Authentication

apiKey

Security Scheme Type API Key
Header parameter name: API Key

Validate API key

Verification endpoint for making sure your API key is working

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{
  • "valid": true
}

Get All Counters

Returns all Counters that can be accessed using your API key, optionally filtered by type.

Authorizations:
apiKey
query Parameters
limit
integer
Default: 25

Maximum number of records to return

offset
integer
Default: "0"

Number of records to skip

type
string

Type of Counter

Responses

Response samples

Content type
application/json
{
  • "maxRecords": 0,
  • "items":
    [
    ]
}

Get all Zones

Returns all Zones your API key can access.

Authorizations:
apiKey
query Parameters
limit
integer
Default: 25

Maximum number of records to return

offset
integer
Default: "0"

Number of records to skip

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Counter by ID

Finds and returns a Counter by ID

Authorizations:
apiKey
path Parameters
id
required
number

ID of the Counter to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "status": "CONNECTED",
  • "type": "THERMAL_COUNTER",
  • "name": "string",
  • "macAddress": "string",
  • "lastKnownOccupants": "string",
  • "createdAt": "string",
  • "updatedAt": "string"
}

Get Readings by Counter ID

Finds and returns readings by Counter ID

Authorizations:
apiKey
path Parameters
id
required
number

ID of the Counter

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "incomingCount": 0,
  • "outgoingCount": 0,
  • "registeredAt": "string"
}

Submit a footfall reading

Submit a footfall reading

Authorizations:
apiKey
path Parameters
id
required
number

ID of the Counter

Request Body schema: application/json
incomingCount
required
integer

Number of people counted entering

outgoingCount
required
integer

Number of people counted exiting

Responses

Request samples

Content type
application/json
{
  • "incomingCount": 0,
  • "outgoingCount": 0
}

Response samples

Content type
application/json
{
  • "success": true
}

Submit an occupancy reading

Submit an occupancy reading

Authorizations:
apiKey
path Parameters
id
required
number

ID of the Counter

Request Body schema: application/json
occupants
required
integer

Number of occupants

Responses

Request samples

Content type
application/json
{
  • "occupants": 0
}

Response samples

Content type
application/json
{
  • "success": true
}

Get Zone by ID

Finds and returns a Zone by ID

Authorizations:
apiKey
path Parameters
id
required
number

ID of the Zone to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "reportingType": "string",
  • "name": "string",
  • "description": "string",
  • "amberThreshold": 0,
  • "redThreshold": 0,
  • "lastKnownOccupants": 0,
  • "countStart": "string",
  • "countEnd": "string",
  • "createdAt": "string",
  • "updatedAt": "string"
}