Submit occupancy events

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

sourceId

string

required

The unique identifier for the presence source - available from the source system configuration screen in back office.

occupancyEvents

array[object (OccupancyEventDto) {6}]

required

The set of occupancy events to be processed.

timestamp

string

required

Timestamp of the presence event.

Example:

2021-09-01T12:00:00.000Z

locationId

string

required

Calven identifier for the target item where the event occurred.

locationType

enum<string>

required

Type of target item specified by targetId.

Allowed values:

levellocationplacespacezone

eventId

string

required

An identifier for this presence event

occupied

boolean

required

True/false - is the specified location occupied

occupancy

number

optional

The occupancy count of the location. If specified, it must be 0 if occupied is false. It may be 0 if occupied is true

Example

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.calven.com/v1/occupancy' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200Success

application/json

Body

sourceId

string

required

The unique identifier for the presence source - available from the source system configuration screen in back office.

timestamp

string

required

Timestamp that the response was generated.

Example:

2021-09-01T12:00:00.000Z

results

array[object (EventResultDto) {3}]

required

The results for the occupancy events that were submitted

eventId

string

required

An identifier for this presence event

resultCode

number

required

An identifier for this presence event

message

string

required

Explanation message associated with the resultCode

Example

{
  "sourceId": "string",
  "timestamp": "2021-09-01T12:00:00.000Z",
  "results": [
    {
      "eventId": "string",
      "resultCode": 0,
      "message": "string"
    }
  ]
}

🟠401Payload when auth header is missing or invalid