Introduction

This document is intended to provide an overview of all the features of ELOCK2 API and how you can best use them. It is oriented around the nine main functions that ELOCK2 offers

Getting Started

To use the ELOCK2 API in production, the given BASE URL must be verified with the user-specific API KEY.

Headers:

Authorization:BasicAuth

Content-type:application/json

Parameters and variables in 'Headers' must be applied every time a request is made.

STEP 1: --> 1.1.7 Register

In this step, a sessionId is generated using the individual name and your individual API key.The appName and sessionName must be assigned. (the naming must be assigned by you)

SAMPLE Register:

INPUT (JSON)

{
"appName": "Test Session"
"sessionName": "Building1",
"apiKey": "3ab77311-0d4b-461e-91d7-91f8fc16378d"
}

OUTPUT (JSON)

{
"errormessage": "",
"sessionId": "62b2216c-7eed-410c-869c-693a45ea7d82",
"errorcode": 0
}

STEP 2: --> 1.1.4 GetSystems

In this step, we send the "sessionId" value we received in response in the previous step to the relevant address in the request and list the systems that match the "apiKey" value.

SAMPLE GetSystems:

INPUT (JSON)

{
"sessionId": "62b2216c-7eed-410c-869c-693a45ea7d82"
}

OUTPUT (JSON)

{
"result":

 [
     {
            "nr": 1,
            "name": "Test-System"
     },     
     {
            "nr": 2,
            "name": "Company System"
     } 
 ],

"errormessage": "",
"errorcode": 0
}

STEP 3: --> 1.1.6 LoginSystem

In this step, we can make a request with the "systemId" value and "sessionId" value and userId (Default userId=0 --> Administrator) and password (Default password --> 0000) must be sent to login.

SAMPLE LoginSystem:

INPUT (JSON)

{
"sessionId": "62b2216c-7eed-410c-869c-693a45ea7d82",
"systemId": 1,
"userId": 0,
"password": "0000"
}

OUTPUT (JSON)

{
"result": "ok",
"errormessage": "",
"systemName": "Test-System",
"errorcode": 0
}

After this step, you are logged into the system. You can use other methods of ELOCK2 API

SystemService

This resource allows to the management of the respective locking system and the associated systems

Methods:

1.1.1	Method POST	CreateSystem	Creates new system for each facility
1.1.2	Method POST	DeleteSystem	Deletes new system
1.1.3	Method POST	RenameSystem	Renames system
1.1.4	Method POST	GetSystems	Lists all system
1.1.5	Method POST	ChangeSystemPassword	Changes login password for each system
1.1.6	Method POST	LoginSystem	Authenticate in system
1.1.7	Method POST	Register	Creates session
1.1.8	Method GET	GetVersion	Get API's version.
1.1.9	Method POST	GetLoginInfo	Gets current session login info.

1.1.1. CreateSystem

Creates new system for each facility

Login Required

TYPE: POST

INPUT (JSON)

{
password type string
sessionId type string
type type int

 [
  0 = MYD
  1 = MIFARE
  2 = DESFIRE
  ]

systemName type string
}

OUTPUT (JSON)

{
result type string
errorCode type int
systemId type int
errorText type string
}

Usage: SystemService/CreateSystem

1.1.2. DeleteSystem

Deletes new system

Login Required

TYPE: POST

INPUT (JSON)

{
systemId type int
sessionId type string
adminPassword type string
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: SystemService/DeleteSystem

1.1.3. RenameSystem

Renames system

Login Required

TYPE: POST

INPUT (JSON)

{
name type string
sessionId type string
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: SystemService/RenameSystem

1.1.4. GetSystems

Lists all system

TYPE: POST

INPUT (JSON)

{
sessionId type string
}

OUTPUT (JSON)

{
result type array

 [
     systemId type int
     systemName type string
     systemType type int
 ]
 Information:
 systemType=0  -> System MYD
 systemType=1  -> System Mifare
 systemType=2  -> System DESFire

errorCode type int
errorText type string
}

Usage: SystemService/GetSystems

1.1.5. ChangeSystemPassword

Changes login password for each system

Login Required

TYPE: POST

INPUT (JSON)

{
systemId type int
oldPassword type string
sessionId type string
newPassword type string
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: SystemService/ChangeSystemPassword

1.1.6. LoginSystem

Authenticate in system

TYPE: POST

INPUT (JSON)

{
systemId type int
userId type int

       [get user id's from UserServices/GetUsers] --> userId=0 (default: Administrator)

password type string
sessionId type string
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
systemName type string
}

Usage: SystemService/LoginSystem

1.1.7. Register

Creates session

TYPE: POST

INPUT (JSON)

{
appName type string
sessionName type string
apiKey type string
}

OUTPUT (JSON)

{
sessionId type string
errorCode type int
errorText type string
}

Usage: SystemService/Register

1.1.8. GetVersion

Get API's version.

TYPE: GET

OUTPUT (JSON)

{
version type string
}

Usage: SystemService/GetVersion

1.1.9. GetLoginInfo

Gets current session login info.

TYPE: POST

INPUT (JSON)

{
sessionId type string
}

OUTPUT (JSON)

{
result type object
errorCode type int
errorText type string
}

Usage: SystemService/GetLoginInfo

RuleGroupService

This resource allows to the management of rule groups

Methods:

1.2.1	Method POST	CreateGroup	Creates new rule groups
1.2.2	Method POST	DeleteGroup	Deletes rule group
1.2.3	Method POST	RenameGroup	Rename groups
1.2.4	Method POST	AddRule	Add Locks and Users to each Rule
1.2.5	Method POST	GetGroups	Lists rule groups
1.2.6	Method POST	GetGroupCount	Gets the number of rule groups in the system
1.2.7	Method POST	GetRules	List rules in defined rule group
1.2.8	Method POST	DeleteRule	Deletes requested rule.

1.2.1. CreateGroup

Creates new rule groups

TYPE: POST

INPUT (JSON)

{
name type string
sessionId type string
}

OUTPUT (JSON)

{
result type object
errorcode type int
errorText type string
}

Usage: RuleGroupService/CreateGroup

1.2.2. DeleteGroup

Deletes rule group

TYPE: POST

INPUT (JSON)

{
nr type int
sessionId type string
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: RuleGroupService/DeleteGroup

1.2.3. RenameGroup

Rename groups

TYPE: POST

INPUT (JSON)

{
nr type int
name type string
sessionId type string
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: RuleGroupService/RenameGroup

1.2.4. AddRule

Add Locks and Users to each Rule

TYPE: POST

INPUT (JSON)

{
ruleGroupId type int
keyId type array
keyGroupId type array
lockId type array
lockGroupId type array
timeGroupId type array
sessionId type string
comment type string
open type boolean
active type boolean
}

OUTPUT (JSON)

{
result type object
errorCode type int
errorText type string
}

Usage: RuleGroupService/AddRule

1.2.5. GetGroups

Lists rule groups

TYPE: POST

INPUT (JSON)

{
sessionId type string
}

OUTPUT (JSON)

{
result type array
errorCode type int
errorText type string
}

Usage: RuleGroupService/GetGroups

1.2.6. GetGroupCount

Gets the number of rule groups in the system

TYPE: POST

INPUT (JSON)

{
sessionId type string
}

OUTPUT (JSON)

{
result type int
errorCode type int
errorText type string
}

Usage: RuleGroupService/GetGroupCount

1.2.7. GetRules

List rules in defined rule group

TYPE: POST

INPUT (JSON)

{
sessionId type string
ruleGroupId type int
}

OUTPUT (JSON)

{
result type array
errorCode type int
errorText type string
}

Usage: RuleGroupService/GetRules

1.2.8. DeleteRule

Deletes requested rule.

TYPE: POST

INPUT (JSON)

{
sessionId type string
nr type int
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: RuleGroupService/DeleteRule

LockService

This resource allows the management of all offline and online locking systems

Methods:

1.3.1	Method POST	CreateLock	Creates new locks for defined system
1.3.2	Method POST	RenameLock	Renames defined lock
1.3.3	Method POST	GetLocks	Lists all locks
1.3.4	Method POST	UpdateProperties	Changes defined lock property
1.3.5	Method POST	GetLock	Gets requested lock informations.
1.3.6	Method POST	GetLockCount	Gets the number of locks in the system
1.3.7	Method POST	GetLockTypes	Gets all supported types of a lock.

1.3.1. CreateLock

Creates new locks for defined system

TYPE: POST

INPUT (JSON)

{
sessionId type string
name type string
}

OUTPUT (JSON)

{
result type object
errorCode type int
errorText type string
}

Usage: LockService/CreateLock

1.3.2. RenameLock

Renames defined lock

TYPE: POST

INPUT (JSON)

{
nr type int
name type string
sessionId type string
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: LockService/RenameLock

1.3.3. GetLocks

Lists all locks

TYPE: POST

INPUT (JSON)

{
sessionId type string
}

OUTPUT (JSON)

{
result type object

nr type int

errorCode type int
errorText type string
}

Usage: LockService/GetLocks

1.3.4. UpdateProperties

Changes defined lock property

TYPE: POST

INPUT (JSON)

{
nr type int
sessionId type string
property type object
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: LockService/UpdateProperties

1.3.5. GetLock

Gets requested lock informations.

TYPE: POST

INPUT (JSON)

{
sessionId type string
nr type int
}

OUTPUT (JSON)

{
result type object
errorCode type int
errorText type string
}

Usage: LockService/GetLock

1.3.6. GetLockCount

Gets the number of locks in the system

TYPE: POST

INPUT (JSON)

{
sessionId type string
}

OUTPUT (JSON)

{
result type int
errorCode type int
errorText type string
}

Usage: LockService/GetLockCount

1.3.7. GetLockTypes

Gets all supported types of a lock.

TYPE: POST

INPUT (JSON)

{
sessionId type string
}

OUTPUT (JSON)

{
result type array
errorCode type int
errorText type string
}

Usage: LockService/GetLockTypes

LockGroupService

This resource allows the management of lock groups

Methods:

1.4.1	Method POST	CreateGroup	Creates new lock groups
1.4.2	Method POST	DeleteGroup	Delete lock groups
1.4.3	Method POST	RenameGroup	Rename lock groups
1.4.4	Method POST	GetGroups	Lists all lock groups
1.4.5	Method POST	AddLock	Add lock in defined lock group
1.4.6	Method POST	RemoveLock	Remove lock in defined lock group
1.4.7	Method POST	GetLocks	List locks in defined lock group
1.4.8	Method POST	GetGroupCount	Gets the number of lock groups in the system
1.4.9	Method POST	GetLockGroups	List lock groups in defined lock group

1.4.1. CreateGroup

Creates new lock groups

TYPE: POST

INPUT (JSON)

{
name type string
sessionId type string
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
groupId type int
}

Usage: LockGroupService/CreateLockGroup

1.4.2. DeleteGroup

Delete lock groups

TYPE: POST

INPUT (JSON)

{
nr type int
sessionId type string
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: LockGroupService/DeleteLockGroup

1.4.3. RenameGroup

Rename lock groups

TYPE: POST

INPUT (JSON)

{
nr type int
name type string
sessionId type string
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: LockGroupService/RenameLockGroup

1.4.4. GetGroups

Lists all lock groups

TYPE: POST

INPUT (JSON)

{
sessionId type string
}

OUTPUT (JSON)

{
result type array
errorCode type int
errorText type string
}

Usage: LockGroupService/GetLockGroups

1.4.5. AddLock

Add lock in defined lock group

TYPE: POST

INPUT (JSON)

{
groupId type int
lockId type int
sessionId type string
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: LockGroupService/AddLock

1.4.6. RemoveLock

Remove lock in defined lock group

TYPE: POST

INPUT (JSON)

{
groupId type int
lockId type int
sessionId type string
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: LockGroupService/RemoveLock

1.4.7. GetLocks

List locks in defined lock group

TYPE: POST

INPUT (JSON)

{
nr type int
sessionId type string
}

OUTPUT (JSON)

{
result type array
errorCode type int
errorText type string
}

Usage: LockGroupService/GetLocks

1.4.8. GetGroupCount

Gets the number of lock groups in the system

TYPE: POST

INPUT (JSON)

{
sessionId type string
}

OUTPUT (JSON)

{
result type int
errorCode type int
errorText type string
}

Usage: LockGroupService/GetGroupCount

1.4.9. GetLockGroups

List lock groups in defined lock group

TYPE: POST

INPUT (JSON)

{
sessionId type string
nr type int
}

OUTPUT (JSON)

{
result type array
errorCode type int
errorText type string
}

Usage: LockGroupService/GetLockGroups

KeyService

This resource allows the management of Users and their permissions

Methods:

1.5.1	Method POST	CreateKey	Creates new key *User
1.5.2	Method POST	DeleteKey	Moves defined key into trash.
1.5.3	Method POST	RenameKey	Rename key *User name
1.5.4	Method POST	GetKeys	List all keys *Users
1.5.5	Method POST	UpdateProperties	Change key *User properties
1.5.6	Method POST	AddPhone	The service reads the e2id file content in "byte array" type.
1.5.7	Method POST	ExportPhonePermissions	The service sends the file name as a "filename" variable as "string" type and the file content as a "result" variable as "byte array" type when sending the person permissions.
1.5.8	Method POST	GetKey	Gets requested key informations.
1.5.9	Method POST	EmptyTrash	Empty keys in trash.
1.5.10	Method POST	GetKeyCount	Gets the number of keys in the system
1.5.11	Method POST	DeletePhone	Deletes requested phone.
1.5.12	Method POST	GetKeyTypes	Gets all supported types of a key.
1.5.13	Method POST	AddAccess	Adds accesses for keys to requested locks with defined timezone values.
1.5.14	Method POST	RemoveAccess	Removes accesses for keys from requested locks.
1.5.15	Method POST	GetAccesses	Retrieves the accesses of keys for locks.
1.5.16	Method POST	CreateQrCode	Creates a key as Qr-Code.
1.5.17	Method POST	GetQrCode	Gets created Qr-Code key.
1.5.18	Method POST	GetAllAccesses	Retrieves the accesses of keys for locks.

1.5.1. CreateKey

Creates new key *User

TYPE: POST

INPUT (JSON)

{
name type string
surname type string
sessionId type string
}

OUTPUT (JSON)

{
result type object
errorCode type int
errorText type string
}

Usage: KeyService/CreateKey

1.5.2. DeleteKey

Moves defined key into trash.

TYPE: POST

INPUT (JSON)

{
nr type int
sessionId type string
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: KeyService/DeleteKey

1.5.3. RenameKey

Rename key *User name

TYPE: POST

INPUT (JSON)

{
nr type int
name type string
surname type string
sessionId type string
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: KeyService/RenameKey

1.5.4. GetKeys

List all keys *Users

TYPE: POST

INPUT (JSON)

{
sessionId type string
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: KeyService/GetKeys

1.5.5. UpdateProperties

Change key *User properties

TYPE: POST

INPUT (JSON)

{
nr type int
sessionId type string
property type object
}

OUTPUT (JSON)

{
result type object
errorCode type int
errorText type string
}

Usage: KeyService/UpdateProperties

1.5.6. AddPhone

The service reads the e2id file content in "byte array" type.

TYPE: POST

INPUT (JSON)

{
keyId type int
e2idFile type array
sessionId type string
e2idFilename type string
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: KeyServices/AddPhone

1.5.7. ExportPhonePermissions

The service sends the file name as a "filename" variable as "string" type and the file content as a "result" variable as "byte array" type when sending the person permissions.

TYPE: POST

INPUT (JSON)

{
keyId type int
sessionId type string
}

OUTPUT (JSON)

{
result type array
errorCode type int
errorText type string
filename type string
}

Usage: KeyService/ExportPhonePermissions

1.5.8. GetKey

Gets requested key informations.

TYPE: POST

INPUT (JSON)

{
sessionId type string
nr type int
}

OUTPUT (JSON)

{
result type object
errorCode type int
errorText type string
}

Usage: KeyService/GetKey

1.5.9. EmptyTrash

Empty keys in trash.

TYPE: POST

INPUT (JSON)

{
sessionId type string
password type string
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: KeyService/EmptyTrash

1.5.10. GetKeyCount

Gets the number of keys in the system

TYPE: POST

INPUT (JSON)

{
sessionId type string
}

OUTPUT (JSON)

{
result type int
errorCode type int
errorText type string
}

Usage: KeyService/GetKeyCount

1.5.11. DeletePhone

Deletes requested phone.

TYPE: POST

INPUT (JSON)

{
sessionId type string
keyId type int
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: KeyService/DeletePhone

1.5.12. GetKeyTypes

Gets all supported types of a key.

TYPE: POST

INPUT (JSON)

{
sessionId type string
}

OUTPUT (JSON)

{
result type array
errorCode type int
errorText type string
}

Usage: KeyService/GetKeyTypes

1.5.13. AddAccess

Adds accesses for keys to requested locks with defined timezone values.

Requires MyD system.

TYPE: POST

INPUT (JSON)

{
sessionId type string
accesses type array

{
 keyNr type int
 lockNr type int
 timezone type int
 }

}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: KeyService/AddAccess

1.5.14. RemoveAccess

Removes accesses for keys from requested locks.

Requires MyD system.

TYPE: POST

INPUT (JSON)

{
sessionId type string
accesses type array

{
 keyNr type int
 lockNr type int
 }

}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: KeyService/RemoveAccess

1.5.15. GetAccesses

Retrieves the accesses of keys for locks.

Requires MyD system.

TYPE: POST

INPUT (JSON)

{
sessionId type string
accesses type array

{
 keyNr type int
 lockNr type int
 }

}

OUTPUT (JSON)

{
result type array

{
 keyNr type int
 lockNr type int
 selected type boolean
 timezone type int
 }

errorCode type int
errorText type string
}

Usage: KeyService/GetAccesses

1.5.16. CreateQrCode

Creates a key as Qr-Code.

Requires MyD system.

TYPE: POST

INPUT (JSON)

{
sessionId type string
keyNr type int
}

OUTPUT (JSON)

{
result type array

returns Qr-Code image png format as bytearray

errorCode type int
errorText type string
}

Usage: KeyService/CreateQrCode

1.5.17. GetQrCode

Gets created Qr-Code key.

Requires MyD system.

TYPE: POST

INPUT (JSON)

{
sessionId type string
keyNr type int
}

OUTPUT (JSON)

{
result type array

returns Qr-Code image png format as bytearray

errorCode type int
errorText type string
}

Usage: KeyService/GetQrCode

1.5.18. GetAllAccesses

Retrieves the accesses of keys for locks.

Requires MyD system.

TYPE: POST

INPUT (JSON)

{
sessionId type string
}

OUTPUT (JSON)

{
result type array
errorCode type int
errorText type string
}

Usage: KeyService/GetAllAccesses

KeyGroupService

This resource allows the management of key groups

Methods:

1.6.1	Method POST	CreateGroup	Creates new key groups
1.6.2	Method POST	DeleteGroup	Delete key groups
1.6.3	Method POST	RenameGroup	Rename key groups
1.6.4	Method POST	GetGroups	Lists all key groups
1.6.5	Method POST	AddKey	Add key in defined key group
1.6.6	Method POST	RemoveKey	Remove key in defined key group
1.6.7	Method POST	GetKeys	List key in defined key group
1.6.8	Method POST	GetGroupCount	Gets the number of key groups in the system
1.6.9	Method POST	GetKeyGroups	List key groups in defined key group

1.6.1. CreateGroup

Creates new key groups

TYPE: POST

INPUT (JSON)

{
name type string
sessionId type string
}

OUTPUT (JSON)

{
result type object
errorCode type int
errorText type string
}

Usage: KeyGroupService/CreateGroup

1.6.2. DeleteGroup

Delete key groups

TYPE: POST

INPUT (JSON)

{
nr type int
sessionId type string
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: KeyGroupService/DeleteGroup

1.6.3. RenameGroup

Rename key groups

TYPE: POST

INPUT (JSON)

{
nr type int
name type string
sessionId type string
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: KeyGroupService/RenameGroup

1.6.4. GetGroups

Lists all key groups

TYPE: POST

INPUT (JSON)

{
sessionId type string
}

OUTPUT (JSON)

{
result type array
errorCode type int
errorText type string
}

Usage: KeyGroupService/GetGroups

1.6.5. AddKey

Add key in defined key group

TYPE: POST

INPUT (JSON)

{
groupId type int
keyId type int
sessionId type string
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: KeyGroupService/AddKey

1.6.6. RemoveKey

Remove key in defined key group

TYPE: POST

INPUT (JSON)

{
groupId type int
keyId type int
sessionId type string
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: KeyGroupService/RemoveKey

1.6.7. GetKeys

List key in defined key group

TYPE: POST

INPUT (JSON)

{
nr type int
sessionId type string
}

OUTPUT (JSON)

{
result type array
errorCode type int
errorText type string
}

Usage: KeyGroupService/GetKeys

1.6.8. GetGroupCount

Gets the number of key groups in the system

TYPE: POST

INPUT (JSON)

{
sessionId type string
}

OUTPUT (JSON)

{
result type int
errorCode type int
errorText type string
}

Usage: KeyGroupService/GetGroupCount

1.6.9. GetKeyGroups

List key groups in defined key group

TYPE: POST

INPUT (JSON)

{
sessionId type string
nr type int
}

OUTPUT (JSON)

{
result type array
errorCode type int
errorText type string
}

Usage: KeyGroupService/GetKeyGroups

PermissionService

This resource allows the management of permissions

Methods:

1.7.1	Method GET	ListKeyPermissions	List all Permissions of defined key *User
1.7.2	Method GET	ListKeyGroupPermissions	List all Permissions of defined key groups *User groups
1.7.3	Method GET	ListLockPermissions	List all Permissions of defined lock
1.7.4	Method GET	ListLockGroupPermissions	List all Permissions of defined lock groups
1.7.5	Method POST	RemoveKeyPermissions	Remove all Permissions of defined User
1.7.6	Method POST	RemoveKeyGroupPermissions	Remove defined Permissions Key Groups of defined User
1.7.7	Method POST	RemoveLockPermissions	Remove all Permissions of defined locks
1.7.8	Method POST	RemoveLockGroupPermissions	Remove defined Permissions Lock Groups of defined locks
1.7.9	Method POST	AddKeyPermissions	Authorize keys *Users with individual permissions
1.7.10	Method POST	AddKeyGroupPermissions	Authorize key groups *Users with individual permissions
1.7.11	Method POST	AddLockPermissions	Authorize locks with individual permissions
1.7.12	Method POST	AddLockGroupPermissions	Authorize lock groups with individual permissions

1.7.1. ListKeyPermissions

List all Permissions of defined key *User

Coming soon...

TYPE: GET

INPUT (JSON)

{
sessionId type string
systemId type int
keyId type int
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string

{
  [ 
	    objectType type int (possible values:0,1)  >>0=Lock 1=LockGroup
	    objectId type int
		permission type int (possible values:0,1)  >>0=Denied 1=Authorized
  ]
}

}

Usage: PermissionService/ListKeyPermissions

1.7.2. ListKeyGroupPermissions

List all Permissions of defined key groups *User groups

Coming soon...

TYPE: GET

INPUT (JSON)

{
sessionId type string
systemId type int
groupId type int
}

OUTPUT (JSON)

{
result type string
errorCode type int

{
	[
	    objectType type int (possible values:0,1)  >>0=Lock 1=LockGroup
	    objectId type int
		permission type int (possible values:0,1)  >>0=Denied 1=Authorized
	]
 }

}

Usage: PermissionService/ListKeyGroupPermissions

1.7.3. ListLockPermissions

List all Permissions of defined lock

Coming soon...

TYPE: GET

INPUT (JSON)

{
sessionId type string
systemId type int
lockId type int
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string

 {
	[
	    objectType type int (possible values:0,1)  >>0=Key 1=KeyGroup
	    objectId type int
		permission type int (possible values:0,1)  >>0=Denied 1=Authorized		
	]
 }

}

Usage: PermissionService/ListLockPermissions

1.7.4. ListLockGroupPermissions

List all Permissions of defined lock groups

Coming soon...

TYPE: GET

INPUT (JSON)

{
sessionId type string
systemId type int
keyId type int
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: PermissionService/ListLockGroupPermissions

1.7.5. RemoveKeyPermissions

Remove all Permissions of defined User

Coming soon...

TYPE: POST

INPUT (JSON)

{
sessionId type string
systemId type int
keyId type int
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: PermissionService/RemoveKeyPermissions

1.7.6. RemoveKeyGroupPermissions

Remove defined Permissions Key Groups of defined User

Coming soon...

TYPE: POST

INPUT (JSON)

{
sessionId type string
systemId type int
groupId type int
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: PermissionService/RemoveKeyGroupPermissions

1.7.7. RemoveLockPermissions

Remove all Permissions of defined locks

Coming soon...

TYPE: POST

INPUT (JSON)

{
sessionId type string
systemId type int
lockId type int
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: PermissionService/RemoveLockPermissions

1.7.8. RemoveLockGroupPermissions

Remove defined Permissions Lock Groups of defined locks

Coming soon...

TYPE: POST

INPUT (JSON)

{
sessionId type string
systemId type int
groupId type int
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: PermissionService/RemoveLockGroupPermissions

1.7.9. AddKeyPermissions

Authorize keys *Users with individual permissions

Coming soon...

TYPE: POST

INPUT (JSON)

{
sessionId type string
systemId type int
keyId type int

 {
	   [
	    objectType type int (possible values:0,1)  >>0=Lock 1=LockGroup
	    objectId type int
		permission type int (possible values:0,1)  >>0=Denied 1=Authorized
	]
 }

}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: PermissionService/AddKeyPermissions

1.7.10. AddKeyGroupPermissions

Authorize key groups *Users with individual permissions

Coming soon...

TYPE: POST

INPUT (JSON)

{
sessionId type string
systemId type int
groupId type int

 {
	[
	    objectType type int (possible values:0,1)  >>0=Lock 1=LockGroup
	    objectId type int
            permission type int (possible values:0,1)  >>0=Denied 1=Authorized
	]
 }

}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: PermissionService/AddKeyGroupPermissions

1.7.11. AddLockPermissions

Authorize locks with individual permissions

Coming soon...

TYPE: POST

INPUT (JSON)

{
sessionId type string
systemId type int
lockId type int

{
	[
	    objectType type int (possible values:0,1)  >>0=Key 1=KeyGroup
	    objectId type int
		permission type int (possible values:0,1)  >>0=Denied 1=Authorized
	]
 }

}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: PermissionService/AddLockPermissions

1.7.12. AddLockGroupPermissions

Authorize lock groups with individual permissions

Coming soon...

TYPE: POST

INPUT (JSON)

{
sessionId type string
systemId type int
groupId type int

 {
	[
	    objectType type int (possible values:0,1)  >>0=Key 1=KeyGroup
	    objectId type int
		permission type int (possible values:0,1)  >>0=Denied 1=Authorized
	]
 }

}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: PermissionService/AddLockGroupPermissions

UserService

This resource allows managing authentication from the management software

Methods:

1.8.1	Method POST	CreateUser	Create User *User for the Software Authentication
1.8.2	Method POST	DeleteUser	Delete User *User for the Software Authentication
1.8.3	Method POST	RenameUser	Rename User *User for the Software Authentication
1.8.4	Method POST	GetUsers	List all Users *User for the Software Authentication
1.8.5	Method POST	ChangePassword	Change Password of defined User *User for the Software Authentication
1.8.6	Method POST	GetUser	Gets requested user informations.
1.8.7	Method POST	GetUserCount	Gets the number of users in the system

1.8.1. CreateUser

Create User *User for the Software Authentication

TYPE: POST

INPUT (JSON)

{
sessionId type string
password type string
name type string
}

OUTPUT (JSON)

{
result type object
errorCode type int
errorText type string
}

Usage: UserService/CreateUser

1.8.2. DeleteUser

Delete User *User for the Software Authentication

TYPE: POST

INPUT (JSON)

{
sessionId type string
nr type int
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: UserService/DeleteUser

1.8.3. RenameUser

Rename User *User for the Software Authentication

TYPE: POST

INPUT (JSON)

{
sessionId type string
nr type int
name type string
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: UserService/RenameUser

1.8.4. GetUsers

List all Users *User for the Software Authentication

TYPE: POST

INPUT (JSON)

{
sessionId type string
}

OUTPUT (JSON)

{
result type array
errorCode type int
errorText type string
}

Usage: UserService/GetUsers

1.8.5. ChangePassword

Change Password of defined User *User for the Software Authentication

TYPE: POST

INPUT (JSON)

{
sessionId type string
oldPassword type string
nr type int
newPassword type string
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: UserService/ChangePassword

1.8.6. GetUser

Gets requested user informations.

TYPE: POST

INPUT (JSON)

{
sessionId type string
nr type int
}

OUTPUT (JSON)

{
result type object
errorCode type int
errorText type string
}

Usage: UserService/GetUser

1.8.7. GetUserCount

Gets the number of users in the system

TYPE: POST

INPUT (JSON)

{
sessionId type string
}

OUTPUT (JSON)

{
result type int
errorCode type int
errorText type string
}

Usage: UserService/GetUserCount

TimeGroupService

This resource allows managing Time Groups from the locks and their opening periods for the keys

Methods:

1.9.1	Method POST	CreateGroup	Create new time group
1.9.2	Method POST	DeleteGroup	Delete defined time group
1.9.3	Method POST	RenameGroup	Rename defined time group
1.9.4	Method POST	GetGroups	List all time groups
1.9.5	Method POST	UpdateProperties	Change defined time group properties
1.9.6	Method POST	GetGroupCount	Gets the number of time groups in the system
1.9.7	Method POST	GetGroup	Gets requested time group informations.

1.9.1. CreateGroup

Create new time group

TYPE: POST

INPUT (JSON)

{
sessionId type string
name type string
}

OUTPUT (JSON)

{
result type object
errorCode type int
errorText type string
}

Usage: TimeGroupService/CreateGroup

1.9.2. DeleteGroup

Delete defined time group

TYPE: POST

INPUT (JSON)

{
sessionId type string
nr type int
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: TimeGroupService/DeleteGroup

1.9.3. RenameGroup

Rename defined time group

TYPE: POST

INPUT (JSON)

{
sessionId type string
nr type int
name type string
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string
}

Usage: TimeGroupService/RenameGroup

1.9.4. GetGroups

List all time groups

TYPE: POST

INPUT (JSON)

{
sessionId type string
systemId type int
}

OUTPUT (JSON)

{
result type string
errorCode type int
errorText type string

 [
 	timegroupId type int
	timegroupName type String
 ]

}

Usage: TimeGroupService/GetGroups

1.9.5. UpdateProperties

Change defined time group properties

TYPE: POST

INPUT (JSON)

{
sessionId type string
property type object
nr type int
}

OUTPUT (JSON)

{
result type object
errorCode type int
errorText type string
}

Usage: TimeGroupService/UpdateProperties

1.9.6. GetGroupCount

Gets the number of time groups in the system

TYPE: POST

INPUT (JSON)

{
sessionId type string
}

OUTPUT (JSON)

{
result type int
errorCode type int
errorText type string
}

Usage: TimeGroupService/GetGroupCount

1.9.7. GetGroup

Gets requested time group informations.

TYPE: POST

INPUT (JSON)

{
sessionId type string
nr type int
}

OUTPUT (JSON)

{
result type object
errorCode type int
errorText type string
}

Usage: TimeGroupServices/GetGroup