Programming

This section covers the programming (CRUD) operations for each record type. This includes the parameters which are used in the Detail and Submit APIs.

Most parameters correspond to settings in the Protege WX UI (shown by the Display Name in the parameters table). These settings are described in the Protege WX Programming Reference, available online or via PDF from ICT.

Notes on parameters

• Where a parameter is used to select a record such as a door, area, input or output, the value of the parameter is the Database ID of that record (i.e. the DoorId, AreaId, etc.). For example, Area1=17 refers to the area with an AreaId of 17.

• Parameters that contain multiple values are documented as <Parameter Name>*, where * is the index of the value. For example, for card numbers on a user, CardNum* refers to CardNum0 for the first card number, CardNum1 for the second card number, etc. Each record can support up to a maximum of 128 entries, except for user cards which are limited to 8. This is used particularly for groups.