Command Centre REST API API Reference

Welcome to the developer documentation for the Command Centre REST interface.

The files linked from here show you how you can manage Command Centre using HTTP requests. Each file contains an introduction to its particular area of the API, instructions on authenticating to the server, and tips on how to accomplish common tasks, as well as the usual reference information for paths and data.

They do not show how to set up the Command Centre server to answer your REST calls. To do that, search the Configuration Client's online help for 'REST'.

You could also look at the sample code shipped with Command Centre, on the install media alongside this documentation in the 'Utilities/REST API' folder. There are several Visual Studio projects that compile into .NET applications you could observe making HTTP requests against your own server (in a development environment, of course).

Version: 1.0.0

Documentation suite

Microsoft Edge users please note: early versions did not render the table of contents correctly in the orange column on the left, making navigation difficult. Chrome, Firefox, and recent versions of Edge work well.

The API's reference documentation divides into:

Alarms, events, non-cardholder items, and bulk status monitoring

The alarms and events APIs let you download, monitor, and create events, and download, monitor, and manage alarms.

The alarms and events documentation also covers API calls that support divisions and items as they relate to events, as well as bulk status monitoring.
Cardholders and related items The cardholder parts of the API let you manage your users, their personal data and credentials (cards), and their links to associated items such as access groups, roles, operator groups, competencies, and lockers.
Status and overrides

These functions let you monitor and override the types of Command Centre items that have their own status, including access zones, alarm zones, doors, fence zones, inputs, outputs, macros, elevator groups, interlock groups, and schedules.

Despite its name this section does not cover mass-monitoring item status.

PIV cards This supplement describes how to work with PIV and PIV-I cards. It is separate from the main cardholder documentation in the interest of brevity.

API changes in 9.30

  • The server will accept TLS 1.3 connections when running on suitable versions of Windows. Prior versions would only accept TLS 1.2 connections.

  • An API client can switch its own status between normal and faulty, and can set arbitrary status text. Marking the item as faulty will raise an alarm in Command Centre.

  • Command Centre can, optionally, raise an alarm if an API client has not made an API call within a configurable period. This is an addition to Command Centre, not to the API, but deserves a mention here for developers considering adding status monitoring to their integrations. It may be done for you!

Paths

Documentation by Spectacle