occupancyCounters
Workforce module · 5 operations
List occupancy counter rows
GET/occupancy-counters
A live occupancy counter against the permitted occupant load, with alerts at 80, 90 and 100 percent. Returns a cursor page of occupancy counter rows the caller may see. The default order is `name` ascending. Supports sparse fieldsets and the filter grammar.
Get an occupancy counter
GET/occupancy-counters/{id}
A live occupancy counter against the permitted occupant load, with alerts at 80, 90 and 100 percent. Returns one occupancy counter with its `ETag`. A occupancy counter the caller may not see returns 404.
Set up a counter
POST/occupancy-counters/set-up
Sets up a counter sized by a permit load, a Bible occupant load factor or the space capacity. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
Count people in or out
POST/occupancy-counters/{id}/count
Counts people in (positive) or out (negative) at a door. Crossing 80, 90 or 100 percent alerts the dispatchers. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
Close a counter
POST/occupancy-counters/{id}/close
Stops counting. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.