Standard Values and Models

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.

Available Languages/Locales

NameISO2Device Integer
Englishen0
Spanishes1

Enums

Access Log Result Type

NameDevice IntegerDescription
Access Granted0Access was granted to whoever attempted to open the door.
Not Schedule1The user was identified, but is not scheduled to open the door at the time and date of attempted entry and was denied access.
Unknown User2The user attempting to open the door was not identified and denied access.
Device In Lockdown3The 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 User4The device detected a non-live face, such as a photo, and has denied access.
Card Format Error6The card being used to attempt access is in an incorrect format.
Lockdown Start7A lockdown has been initiated through a device, using a lockdown card. (Lockdown cards can only be made through our portal)
Lockdown End8A lockdown has been ended through a device, using a lockdown card. (Lockdown cards can only be made through our portal)
Doorbell9A person pressed the door bell button

Door/Exit Button Contact Positions

The positions for sensors that keep track of the state of the door and exit button.

NameDevice IntegerDescription
None0No contact position used. If this value is set, the contact type is ignored.
Internal1The door's/exit button's contacts or sensors will be connected directly to the device without any external intermediary.
External2The 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.

Door/Exit Button Contact Types

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.

NameDevice IntegerDescription
Normally Open0If 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 Closed1If 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.

Door State Type

NameDevice IntegerDescription
Closed0The door is closed.
Open Verified1The door was opened after access was granted by the device.
Open Request To Exit2The door was opened after an exit button was pressed.
Open Forced Entry3The 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 Out4The door was kept open past the device's timeout.
No Sensor5No door sensor is set for the device.

Identification Workflow Credentials

NameDevice IntegerDescription
Web0The attempted access was done through the portal.
Mobile1The attempted access was done using a mobile device.
Cloud Key2The attempted access was done through a cloud key.
Face3The attempted access was done through the scanning of a face.
Card4The attempted access was done through the scanning of a card.
ExternalCard5The attempted access was done through the scanning of an external card.
FaceOnCard6The attempted access was done through the scanning of a face on card (a card with a face template saved on it).

Lock State Type

NameDevice IntegerDescription
Locked0The device is in a locked state and any attached door should be locked.
Unlocked1The device is in an unlocked state and any attached door should be unlocked.
Lockdown2The device is currently in lockdown and will not give access to any attached door until the lockdown is ended.
Keep Open3The device is in an indefinite unlocked state caused by either a user or schedule and will remain so until changed.

Supported Wiegand Formats

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 bitsDevice Integer
260
341
372

Device Type

Defines the available device types

Device typeDevice Integer
Camera0
Access Control1
AI Camera2
Gateway3

Models

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.

Access Log

PropertyTypeDescription
accessResultAccessLogResultTypeThe type of access. See here for more information.
timeDateTimeThe date and time that the access log was created.
accountIdlongThe account Id of your account.
deviceNamestringThe name of the device that created the access log.
emailstringThe email of the user who was identified, if any.
firstNamestringThe first name of the user who was identified, if any.
idGuidThe Id of the created access log.
lastNamestringThe last name of the user who was identified, if any.
picturestringThe picture in base64 format that the device took of whoever was in front of the camera.
serialNumberstringThe serial number of the device that created the access log.
siteIdlongThe Id of the site the device is a part of.
siteNamestringThe name of the site the device is a part of.
timeZoneAbbreviationstringThe timezone abbreviation of the timezone the device is in based on the site's timezone.
timeZoneOffsetstringThe timezone offset of the timezone the device is in based on the site's timezone.
userIdGuid?The Id of the user if one was found.
workFlowstringThe identification workflow credential type name that was activated. See here for valid values.

Card

PropertyTypeDescription
cardNumberlongThe card number of the card.
facilityCodeintegerThe facility code of the card.
idlongThe Id of the card.
userIdGuidThe Id of the user whose card it is.

Cron Schedule

PropertyTypeDescription
activeOnHolidaysbooleanWhether or not this schedule will be active on holidays.
cron_expressionstringThe cron expression that is being used for the schedule.
endNullable DateTimeDate until when the schedule will be used, if any.
idlongThe Id of the cron schedule.
scheduleIdlongThe Id of base schedule associated with cron-schedule.
startDateTimeDate when the schedule had begun or will begin being used.
time_durationintegerTime (in minutes) that the schedule remains active from start time in cron expression.

Cloud Key

PropertyTypeDescription
expireOnDateTimeThe expiration of that cloud key.
idintegerThe Id of that cloud key.
sendByEmailbooleanWhether or not that cloud key was sent by email.
sendByTextbooleanWhether or not that cloud key was sent by SMS message.
statusintegerWhether 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.
useOneTimebooleanWhether or not that cloud key was only valid for one use.
userIdGuidThe user for whom that cloud key belongs.
validFromDateTimeThe start date and time when that cloud key was usable.

Device Access Settings

PropertyTypeDescription
doorContactPositionintegerThe type of contact sensor the door has. For more information, see positions.
doorContactTypeintegerThe intended state of the door when not in active use. For more information, see types.
doorOpenTimeoutintegerTime (in seconds) to allow the door to remain open before alerting the system.
exitButtonContactPositionintegerThe type of contact sensor the exit button has. For more information, see positions.
exitButtonContactTypeintegerThe intended state of the exit button when not in use. For more information, see types.
internalRelayEnabledbooleanWhether or not to use the device's own internal relay for the sensors.
ioRelay1EnabledbooleanWhether or not to use one of the external IO relays for the external IO controller.
ioRelay2EnabledbooleanWhether or not to use one of the external IO relays for the external IO controller.
lockReleaseTimeintegerTime (in seconds) for the lock to remain disabled after the door is opened.
serialNumberstringThe serial number of the device.
wiegandFormatintegerThe format for writing the Wiegand output. For more information, see formats.
wiegandInputEnabledbooleanWhether or not to allow the device to read Wiegand input.
wiegandOutputEnabledbooleanWhether or not to allow the device to write Wiegand output.

Device Audio Settings

PropertyTypeDescription
alarmEnabledbooleanWhether or not the alarm is enabled on that device.
languageintegerThe device integer for the current language set to the device. For more information, see languages.
volumeintegerThe volume of the device. Minimum is 0, maximum is 100.

Device Network Settings

PropertyTypeDescription
default_gatewaystringThe default gateway that the device will use to connect to the network. (Only used when the IP mode is set to false)
ip_addressstringThe IP address the device has on the current network.
ip_modeintegerWhether or not the device should automatically handle its network connection settings. The values will either be 0 for static or 1 for DHCP.
netmaskstringThe netmask that the device will use to connect to the network. (Only used when the IP mode is set to false)
dnsServerstringThe DNS server that the device will use to connect to the network. (Only used when the IP mode is set to false)

Group

PropertyTypeDescription
descriptionstringThe description of that group.
idlongThe Id of that group.
namestringThe name of that group.
userCountNullable integerThe number of users for that group. (Only included when getting all groups)

Lockdown Status

PropertyTypeDescription
isLockdownActiveboolWhether or not a lockdown is currently occurring.
startTimeOfLockdownNullable DateTimeThe start date and time of the current or last lockdown that occurred. This field will be null if no lockdown has ever occurred.
anyLockdownWorkflowsboolWhether or not any lockdown workflows exist on your account.
lockdownPlanDurationNullable IntegerThe time (in minutes) that lockdowns will run after being activated (as set in your account settings on the Alocity portal).

Replay Event

PropertyTypeDescription
idGuidThe Id for this event.
registrationDateTimeThe timestamp for when the event occurred.
publicEventIdGuidThe Id of the public event that occurred.
eventSentbooleanWhether or not the event was sent to the webhook.
timesReplayedintegerThe number of times the event was replayed to the webhook.

Schedule

PropertyTypeDescription
descriptionstringThe description of the schedule.
idlongThe Id of the newly created schedule.
isAutomaticbooleanWhether or not to open the doors automatically during the associated cron schedules.
namestringThe name of the schedule.
siteIdlongThe Id of the associated site.
cronSchedulesArray of CronSchedule objectsSee here for more information.

Site

PropertyTypeDescription
descriptionstringThe description of that site.
idlongThe Id of that site.
namestringThe name of that site.
timezoneIdstringThe Id of the timezone of that site.
zonesArray of Zone objectsA list of associated zones. See here for more information.

Timezone

PropertyTypeDescription
displayNamestringThe UTC time offset and the name and/or location for that timezone.
idstringThe Id of that timezone as specified in the Alocity system.
standardNamestringThe standard Windows name for that timezone.

User

PropertyTypeDescription
cardsAn array of Card objectsAn array of all the user's cards. See here for more information.
emailstringThe email of the user.
firstNamestringThe first name of the user.
fullNamestringThe combined first and last name of the user.
idGuidThe Guid Id of the user.
lastNamestringThe last name of the user.
localeISO2stringThe language of the user.
mobileCredentialNullable GuidThe credential used when a user tries to get access using their mobile device.
phoneNumberstringThe phone number of the user.
hasEnrolledFacebooleanWhether or not the user has an enrolled face.
createdAtDateTimeThe timestamp of when the user was created.

Zone

PropertyTypeDescription
descriptionstringThe description of that zone.
idlongThe Id of that zone.
namestringThe name of that zone.