This page details the standard values, enums, and models that will be passed into or returned by requests and sent to webhook. Device Integers are values that will only be used when saving or retrieving device settings.
The Enums and Models sections will be listed in alphabetical order for ease of access.
As the list of timezone data could change at any moment, please use the timezone endpoint to get the most up-to-date list of timezones.
🚧
Important Information
All DateTime objects leaving our system will be in UTC format so you will have to convert them into your local time once you receive them. Any requests that require a DateTime should also be sent in UTC format to ensure that date and time based events occur correctly. If they are not passed in UTC format, they will still be treated as such.
| Name | ISO2 | Device Integer |
|---|
| English | en | 0 |
| Spanish | es | 1 |
| Name | Device Integer | Description |
|---|
| Access Granted | 0 | Access was granted to whoever attempted to open the door. |
| Not Schedule | 1 | The user was identified, but is not scheduled to open the door at the time and date of attempted entry and was denied access. |
| Unknown User | 2 | The user attempting to open the door was not identified and denied access. |
| Device In Lockdown | 3 | The user was denied access because the device is in lockdown and will not allow anyone access until the device's lockdown is ended. |
| Non-Live User | 4 | The device detected a non-live face, such as a photo, and has denied access. |
| Card Format Error | 6 | The card being used to attempt access is in an incorrect format. |
| Lockdown Start | 7 | A lockdown has been initiated through a device, using a lockdown card. (Lockdown cards can only be made through our portal) |
| Lockdown End | 8 | A lockdown has been ended through a device, using a lockdown card. (Lockdown cards can only be made through our portal) |
| Doorbell | 9 | A person pressed the door bell button |
The positions for sensors that keep track of the state of the door and exit button.
| Name | Device Integer | Description |
|---|
| None | 0 | No contact position used. If this value is set, the contact type is ignored. |
| Internal | 1 | The door's/exit button's contacts or sensors will be connected directly to the device without any external intermediary. |
| External | 2 | The door's/exit button's contacts or sensors will be connected through an external IO Controller and from there it will connect to the device. |
This will represent the normal state, or the state that the door or exit button will remain in when not in use. This will help the system and devices understand when they are in an abnormal state, such as someone leaving the door open for too long when it is supposed to be closed.
| Name | Device Integer | Description |
|---|
| Normally Open | 0 | If the door contact type is set to this value, then it means that the door will be open under normal circumstances. If the exit button contact type is set to this value, it means that the button will be unpressed under normal circumstances. |
| Normally Closed | 1 | If the door contact type is set to this value, then it means that the door will be closed under normal circumstances. If the exit button contact type is set to this value, it means that the button will be pressed under normal circumstances. |
| Name | Device Integer | Description |
|---|
| Closed | 0 | The door is closed. |
| Open Verified | 1 | The door was opened after access was granted by the device. |
| Open Request To Exit | 2 | The door was opened after an exit button was pressed. |
| Open Forced Entry | 3 | The device has detected that the door was forced open despite entry not being granted through the device or through the pressing of an exit button. |
| Open Timed Out | 4 | The door was kept open past the device's timeout. |
| No Sensor | 5 | No door sensor is set for the device. |
| Name | Device Integer | Description |
|---|
| Web | 0 | The attempted access was done through the portal. |
| Mobile | 1 | The attempted access was done using a mobile device. |
| Cloud Key | 2 | The attempted access was done through a cloud key. |
| Face | 3 | The attempted access was done through the scanning of a face. |
| Card | 4 | The attempted access was done through the scanning of a card. |
| ExternalCard | 5 | The attempted access was done through the scanning of an external card. |
| FaceOnCard | 6 | The attempted access was done through the scanning of a face on card (a card with a face template saved on it). |
| Name | Device Integer | Description |
|---|
| Locked | 0 | The device is in a locked state and any attached door should be locked. |
| Unlocked | 1 | The device is in an unlocked state and any attached door should be unlocked. |
| Lockdown | 2 | The device is currently in lockdown and will not give access to any attached door until the lockdown is ended. |
| Keep Open | 3 | The device is in an indefinite unlocked state caused by either a user or schedule and will remain so until changed. |
This is used to inform the device of the format for writing Wiegand output. If the Wiegand output is disabled on a device, then this formatting will be ignored.
| Number of bits | Device Integer |
|---|
| 26 | 0 |
| 34 | 1 |
| 37 | 2 |
Defines the available device types
| Device type | Device Integer |
|---|
| Camera | 0 |
| Access Control | 1 |
| AI Camera | 2 |
| Gateway | 3 |
All models that will be available in this documentation. If an object in the documentation is not defined here, it is because it is not a permanent model in our system.
| Property | Type | Description |
|---|
| accessResult | AccessLogResultType | The type of access. See here for more information. |
| time | DateTime | The date and time that the access log was created. |
| accountId | long | The account Id of your account. |
| deviceName | string | The name of the device that created the access log. |
| email | string | The email of the user who was identified, if any. |
| firstName | string | The first name of the user who was identified, if any. |
| id | Guid | The Id of the created access log. |
| lastName | string | The last name of the user who was identified, if any. |
| picture | string | The picture in base64 format that the device took of whoever was in front of the camera. |
| serialNumber | string | The serial number of the device that created the access log. |
| siteId | long | The Id of the site the device is a part of. |
| siteName | string | The name of the site the device is a part of. |
| timeZoneAbbreviation | string | The timezone abbreviation of the timezone the device is in based on the site's timezone. |
| timeZoneOffset | string | The timezone offset of the timezone the device is in based on the site's timezone. |
| userId | Guid? | The Id of the user if one was found. |
| workFlow | string | The identification workflow credential type name that was activated. See here for valid values. |
| Property | Type | Description |
|---|
| cardNumber | long | The card number of the card. |
| facilityCode | integer | The facility code of the card. |
| id | long | The Id of the card. |
| userId | Guid | The Id of the user whose card it is. |
| Property | Type | Description |
|---|
| activeOnHolidays | boolean | Whether or not this schedule will be active on holidays. |
| cron_expression | string | The cron expression that is being used for the schedule. |
| end | Nullable DateTime | Date until when the schedule will be used, if any. |
| id | long | The Id of the cron schedule. |
| scheduleId | long | The Id of base schedule associated with cron-schedule. |
| start | DateTime | Date when the schedule had begun or will begin being used. |
| time_duration | integer | Time (in minutes) that the schedule remains active from start time in cron expression. |
| Property | Type | Description |
|---|
| expireOn | DateTime | The expiration of that cloud key. |
| id | integer | The Id of that cloud key. |
| sendByEmail | boolean | Whether or not that cloud key was sent by email. |
| sendByText | boolean | Whether or not that cloud key was sent by SMS message. |
| status | integer | Whether or not that cloud key is active. Values can be 0 for inactive or 1 for active. Even if a cloud key is expired, it may still show as active. |
| useOneTime | boolean | Whether or not that cloud key was only valid for one use. |
| userId | Guid | The user for whom that cloud key belongs. |
| validFrom | DateTime | The start date and time when that cloud key was usable. |
| Property | Type | Description |
|---|
| doorContactPosition | integer | The type of contact sensor the door has. For more information, see positions. |
| doorContactType | integer | The intended state of the door when not in active use. For more information, see types. |
| doorOpenTimeout | integer | Time (in seconds) to allow the door to remain open before alerting the system. |
| exitButtonContactPosition | integer | The type of contact sensor the exit button has. For more information, see positions. |
| exitButtonContactType | integer | The intended state of the exit button when not in use. For more information, see types. |
| internalRelayEnabled | boolean | Whether or not to use the device's own internal relay for the sensors. |
| ioRelay1Enabled | boolean | Whether or not to use one of the external IO relays for the external IO controller. |
| ioRelay2Enabled | boolean | Whether or not to use one of the external IO relays for the external IO controller. |
| lockReleaseTime | integer | Time (in seconds) for the lock to remain disabled after the door is opened. |
| serialNumber | string | The serial number of the device. |
| wiegandFormat | integer | The format for writing the Wiegand output. For more information, see formats. |
| wiegandInputEnabled | boolean | Whether or not to allow the device to read Wiegand input. |
| wiegandOutputEnabled | boolean | Whether or not to allow the device to write Wiegand output. |
| Property | Type | Description |
|---|
| alarmEnabled | boolean | Whether or not the alarm is enabled on that device. |
| language | integer | The device integer for the current language set to the device. For more information, see languages. |
| volume | integer | The volume of the device. Minimum is 0, maximum is 100. |
| Property | Type | Description |
|---|
| default_gateway | string | The default gateway that the device will use to connect to the network. (Only used when the IP mode is set to false) |
| ip_address | string | The IP address the device has on the current network. |
| ip_mode | integer | Whether or not the device should automatically handle its network connection settings. The values will either be 0 for static or 1 for DHCP. |
| netmask | string | The netmask that the device will use to connect to the network. (Only used when the IP mode is set to false) |
| dnsServer | string | The DNS server that the device will use to connect to the network. (Only used when the IP mode is set to false) |
| Property | Type | Description |
|---|
| description | string | The description of that group. |
| id | long | The Id of that group. |
| name | string | The name of that group. |
| userCount | Nullable integer | The number of users for that group. (Only included when getting all groups) |
| Property | Type | Description |
|---|
| isLockdownActive | bool | Whether or not a lockdown is currently occurring. |
| startTimeOfLockdown | Nullable DateTime | The start date and time of the current or last lockdown that occurred. This field will be null if no lockdown has ever occurred. |
| anyLockdownWorkflows | bool | Whether or not any lockdown workflows exist on your account. |
| lockdownPlanDuration | Nullable Integer | The time (in minutes) that lockdowns will run after being activated (as set in your account settings on the Alocity portal). |
| Property | Type | Description |
|---|
| id | Guid | The Id for this event. |
| registration | DateTime | The timestamp for when the event occurred. |
| publicEventId | Guid | The Id of the public event that occurred. |
| eventSent | boolean | Whether or not the event was sent to the webhook. |
| timesReplayed | integer | The number of times the event was replayed to the webhook. |
| Property | Type | Description |
|---|
| description | string | The description of the schedule. |
| id | long | The Id of the newly created schedule. |
| isAutomatic | boolean | Whether or not to open the doors automatically during the associated cron schedules. |
| name | string | The name of the schedule. |
| siteId | long | The Id of the associated site. |
| cronSchedules | Array of CronSchedule objects | See here for more information. |
| Property | Type | Description |
|---|
| description | string | The description of that site. |
| id | long | The Id of that site. |
| name | string | The name of that site. |
| timezoneId | string | The Id of the timezone of that site. |
| zones | Array of Zone objects | A list of associated zones. See here for more information. |
| Property | Type | Description |
|---|
| displayName | string | The UTC time offset and the name and/or location for that timezone. |
| id | string | The Id of that timezone as specified in the Alocity system. |
| standardName | string | The standard Windows name for that timezone. |
| Property | Type | Description |
|---|
| cards | An array of Card objects | An array of all the user's cards. See here for more information. |
| email | string | The email of the user. |
| firstName | string | The first name of the user. |
| fullName | string | The combined first and last name of the user. |
| id | Guid | The Guid Id of the user. |
| lastName | string | The last name of the user. |
| localeISO2 | string | The language of the user. |
| mobileCredential | Nullable Guid | The credential used when a user tries to get access using their mobile device. |
| phoneNumber | string | The phone number of the user. |
| hasEnrolledFace | boolean | Whether or not the user has an enrolled face. |
| createdAt | DateTime | The timestamp of when the user was created. |
| Property | Type | Description |
|---|
| description | string | The description of that zone. |
| id | long | The Id of that zone. |
| name | string | The name of that zone. |
