Authentication
Methods for session control (log in, log out, etc.)
API | Description | Rights |
---|---|---|
POST api/v1/CreateSession |
Creates session. Returns session id which must then be passed in http headers. After session is created, call SetUserRights (and get LockGroups before that if necessary to get a lockgroup_id) |
|
POST api/v1/SetLockgroup |
Sets user's session's lockgroup information. Call after CreateSession and GetLockGroups is called. |
|
GET api/v1/KillSession |
Ends session |
|
GET api/v1/Test |
Connection test. Returns "Test OK". |
CalendarDatas
Methods for retrieving/editing calendars' data
API | Description | Rights |
---|---|---|
GET api/v1/CalendarDataTitles/{id}/CalendarDatas?startDate={startDate}&endDate={endDate} |
Returns calendar data for given calendar |
CanEditCalendars (2251799813685248) |
GET api/v1/CalendarDatas/{id} |
Returns calendar data information by calendar data id |
CanEditCalendars (2251799813685248) |
POST api/v1/CalendarDatas |
Adds calendar data |
CanEditCalendars (2251799813685248) |
DELETE api/v1/CalendarDatas/{id} |
Deletes calendar data |
CanEditCalendars (2251799813685248) |
PUT api/v1/CalendarDatas |
Updates calendar data |
CanEditCalendars (2251799813685248) |
CalendarDataSecurityRoleLinks
Methods to link calendar datas to security roles and retrieve links
API | Description | Rights |
---|---|---|
GET api/v1/CalendarDatas/{id}/CalendarDataSecurityRoleLinks |
Gets links for given calendar data |
CanEditCalendars (2251799813685248) |
GET api/v1/SecurityRoles/{id}/CalendarDataSecurityRoleLinks |
Gets links for given security role |
CanEditCalendars (2251799813685248) |
PUT api/v1/CalendarDatas/{id}/CalendarDataSecurityRoleLinks |
Links calendar datas to security roles. The whole result set must be given when setting links because this method handles both adding/removing of links. If no links are given, clears all calendar data's links. |
CanEditCalendars (2251799813685248) |
POST api/v1/CalendarDatas/{id}/CalendarDataSecurityRoleLinks |
Adds security role links to calendar data. |
CanEditCalendars (2251799813685248) |
POST api/v1/CalendarDatas/{id}/CalendarDataSecurityRoleLinks/Delete |
Deletes security role links from calendar data. |
CanEditCalendars (2251799813685248) |
CalendarDataTitles
Methods for retrieving/editing calendars
API | Description | Rights |
---|---|---|
GET api/v1/CalendarDataTitles |
Returns all calendars user has access to |
CanEditCalendars (2251799813685248) |
GET api/v1/CalendarDataTitles/{id} |
Gets given calendar's information |
CanEditCalendars (2251799813685248) |
POST api/v1/CalendarDataTitles |
Adds new calendar |
CanEditCalendars (2251799813685248) |
PUT api/v1/CalendarDataTitles |
Updates existing calendar |
CanEditCalendars (2251799813685248) |
DELETE api/v1/CalendarDataTitles/{id} |
Deletes calendar by id |
CanEditCalendars (2251799813685248) |
CalendarNetworkModuleRelayLinks
Methods to link calendars to network module device relays and retrieve links
API | Description | Rights |
---|---|---|
GET api/v1/CalendarDataTitles/{id}/CalendarNetworkModuleDeviceRelayLinks |
Gets links for given calendar |
CanMaintenance (2147483648) |
GET api/v1/NetworkModuleDeviceRelays/{id}/CalendarNetworkModuleDeviceRelayLinks |
Gets links for given network module device relay |
CanMaintenance (2147483648) |
PUT api/v1/CalendarDataTitles/{id}/CalendarNetworkModuleDeviceRelayLinks |
Links calendars to network module device relays. The whole result set must be given when setting links because this method handles both adding/removing of links. If no links are given, clears all calendar's links. |
CanMaintenance (2147483648) |
Keys
Methods for managing keys
API | Description | Rights |
---|---|---|
GET api/v1/Keys |
Gets all keys in lockgroup user has rights to |
canBrowseKeyList (512) |
GET api/v1/Keys/{id} |
Gets key information by key id |
canBrowseKeyList (512) |
GET api/v1/Keys/GetByRomIds?romIds[0]={romIds[0]}&romIds[1]={romIds[1]} |
Gets key informations by keys' rom ids |
canBrowseKeyList (512) |
GET api/v1/Persons/{id}/Keys |
Gets keys linked to the given person by person id |
canBrowseKeyList (512) |
POST api/v1/Keys |
Adds new key |
CanEditKey (524288) |
PUT api/v1/Keys?updateVersionCode={updateVersionCode} |
Updates existing key |
CanEditKey (524288) |
DELETE api/v1/Keys/{id} |
Deletes given key |
CanEditKey (524288) |
PUT api/v1/Keys/{id}/SecurityAccesses |
Updates key's security accesses and time limits |
CanEditKeyAccess (33554432) |
GET api/v1/Keys/{id}/SecurityAccesses?mode={mode} |
Gets key's security accesses |
One of the following rights required: CanBrowseSecurityAccessList (2097152) CanEditSecurityAccess (4194304) canBrowseKeyList (512) CanEditKey (524288) CanEditKeyAccess (33554432) |
PUT api/v1/Keys/{id}/ReplaceWith/{replaceWithKeyId} |
Replaces a key with another key. Sets replaced key into blacklist. |
CanReplaceKey (562949953421312) |
LockGroups
Methods for accessing lock groups
API | Description | Rights |
---|---|---|
GET api/v1/LockGroups |
Gets all LockGroups available for user |
Locks
Methods for managing locks
API | Description | Rights |
---|---|---|
GET api/v1/Locks |
Returns lock list |
CanBrowseLocks (1073741824) |
GET api/v1/Locks/{id} |
Returns single lock |
CanBrowseLocks (1073741824) |
POST api/v1/Locks |
Adds new lock |
CanShowLockTools (16) CanEditLock (262144) |
PUT api/v1/Locks |
Updates existing lock |
CanEditLock (262144) |
DELETE api/v1/Locks/{id} |
Deletes given lock or removes it from use if it's programmed to keep history and logs. |
CanEditLock (262144) |
PUT api/v1/Locks/{id}/SecurityAccesses |
Updates locks' access rights |
CanEditLockAccess (536870912) |
GET api/v1/Locks/{id}/SecurityAccesses?mode={mode} |
Gets lock's security accesses |
One of the following rights required: CanBrowseSecurityAccessList (2097152) CanEditSecurityAccess (4194304) CanBrowseLocks (1073741824) CanEditLock (262144) CanEditLockAccess (536870912) |
NetworkModuleDeviceRelays
Methods for Network module device relays.
API | Description | Rights |
---|---|---|
GET api/v1/NetworkModules/{id}/NetworkModuleDeviceRelays |
Returns relays which belong to given network module |
CanMaintenance (2147483648) |
GET api/v1/NetworkModuleDevices/{id}/NetworkModuleDeviceRelays |
Returns relays which belong to given network module device |
CanMaintenance (2147483648) |
GET api/v1/NetworkModuleDeviceRelays/{id} |
Returns information about specific network module device relay |
CanMaintenance (2147483648) |
NetworkModuleDevices
Methods for Network module devices.
API | Description | Rights |
---|---|---|
GET api/v1/NetworkModuleDevices |
Returns all network module devices |
CanMaintenance (2147483648) |
GET api/v1/NetworkModuleDevices/{id} |
Returns network module device by ID |
CanMaintenance (2147483648) |
GET api/v1/NetworkModules/{id}/NetworkModuleDevices |
Returns network module devices which belong to given Network Module |
CanMaintenance (2147483648) |
NetworkModules
Methods for Network modules.
API | Description | Rights |
---|---|---|
GET api/v1/NetworkModules |
Returns list of network modules |
CanMaintenance (2147483648) |
GET api/v1/NetworkModules/{id} |
Returns information for given network module |
CanMaintenance (2147483648) |
PersonRoles
Methods for getting person roles
API | Description | Rights |
---|---|---|
GET api/v1/PersonRoles |
Gets all person roles in lockgroup user has rights to |
CanBrowsePersonRoleList (32768) |
GET api/v1/PersonRoles/{id} |
Gets single role by its ID |
CanBrowsePersonRoleList (32768) |
GET api/v1/Persons/{id}/PersonRoles |
Gets all person roles linked to given Person ID |
CanBrowsePersonRoleList (32768) |
Persons
Methods to access Persons
API | Description | Rights |
---|---|---|
GET api/v1/Persons |
Gets all persons user has rights to. Requires CanBrowsePersonList right. |
CanBrowsePersonList (2) |
GET api/v1/Persons/{id} |
Gets a single person by its ID. Requires CanBrowsePersonList right |
CanBrowsePersonList (2) |
GET api/v1/Persons/{id}/NortecActivationCode |
Get's Nortec activation code |
CanBrowsePersonList (2) |
GET api/v1/Persons/GetByExternalPersonIds?externalPersonIds[0]={externalPersonIds[0]}&externalPersonIds[1]={externalPersonIds[1]} |
Gets persons by their external person ids |
CanBrowsePersonList (2) |
DELETE api/v1/Persons/{id} |
Deletes a person |
CanEditPerson (65536) |
POST api/v1/Persons |
Inserts new persons |
CanEditPerson (65536) |
PUT api/v1/Persons |
Updates existing persons |
CanEditPerson (65536) |
RealEstate
Methods to access real estates
API | Description | Rights |
---|---|---|
GET api/v1/RealEstates |
Returns list of lock group's real estates |
CanAccount (1) |
SecurityAccess
Methods to access security accesses
API | Description | Rights |
---|---|---|
GET api/v1/SecurityAccesses |
Returns list of lock group's security accesses |
CanBrowseSecurityAccessList (2097152) |
POST api/v1/SecurityAccesses |
Adds new security access |
CanEditSecurityAccess (4194304) |
PUT api/v1/SecurityAccesses |
Updates existing security access |
CanEditSecurityAccess (4194304) |
DELETE api/v1/SecurityAccesses/{id} |
Deletes given security access |
CanEditSecurityAccess (4194304) |
SecurityRoles
API | Description | Rights |
---|---|---|
GET api/v1/SecurityRoles |
Returns all Security Roles |
CanBrowsePersonRoleList (32768) |
GET api/v1/SecurityRoles/{id} |
Returns security role data by its ID |
CanBrowsePersonRoleList (32768) |
POST api/v1/SecurityRoles |
Adds new security role |
CanEditPersonRole (16384) |
PUT api/v1/SecurityRoles |
Updates existing security role |
CanEditPersonRole (16384) |
DELETE api/v1/SecurityRoles/{id} |
Deletes security role |
CanEditPersonRole (16384) |
Url
API | Description | Rights |
---|---|---|
POST api/v1/Url/GetUrl |
Returns url to use with public API |
|
POST api/v2/Url/GetUrl |
Returns url to use with public API |
Webhooks
Methods to handle webhooks
Additional infoAPI | Description | Rights |
---|---|---|
POST api/v1/Webhooks/Subscriptions |
Adds new webhook subscription |
CanMaintenance (2147483648) |
DELETE api/v1/Webhooks/Subscriptions/{id} |
Deletes webhook subscription |
CanMaintenance (2147483648) |
GET api/v1/Webhooks/Events |
Gets all supported webhook events which can be subscripted to |
CanMaintenance (2147483648) |
GET api/v1/Webhooks/Subscriptions/{id}/Payloads?state={state} |
Gets payloads which have the given state. Returns most recent, maximum of 1000 payloads. |
CanMaintenance (2147483648) |
GET api/v1/Webhooks/Subscriptions/{id} |
Gets webhook subscription information |
CanMaintenance (2147483648) |
GET api/v1/Webhooks/Subscriptions |
Gets webhook subscriptions |
CanMaintenance (2147483648) |
GET api/v1/Webhooks/Subscriptions/PendingPayloads |
Gets webhook subscriptions which have sent payloads that aren't sent successfully (state = 3 or 4). |
CanMaintenance (2147483648) |
PUT api/v1/Webhooks/Subscriptions |
Updates existing webhook subscription |
CanMaintenance (2147483648) |
Zone
Methods to access Zones
API | Description | Rights |
---|---|---|
GET api/v1/Zones |
Gets all zones in lockgroup. |
CanBrowseSpaceList (2048) |