BokaMera.API.Host

<back to all web services

AddSiedleCodeLockSetting

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/codelock/siedle/settingsAdd settings for the code lock of the company of the currently logged in userAdd settings for code lock of the company of the currently logged in user.
AddSiedleCodeLockSetting Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
ApiEndpointbodystringYesThe api endpoint of the code lock
ApiPortbodystringYesThe api port for the code lock.
DeviceIdbodystringNoThe device id to the code lock.
IntegrationTypebodystringNoThe integration type to the code lock. 1 = Local Api, 2 = Cloud Based Api
UsernamebodystringYesThe username to logon to the code lock.
PasswordbodystringYesThe password to logon to the code lock.
SiedleIntegrationType Enum:
NameValue
LocalApi1
CloudBasedApi2
CodeLockSiedleSettingResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
ApiEndpointformstringNoThe api endpoint of the code lock
ApiPortformstringNoThe api port for the code lock.
DeviceIdformstringNoThe device id to the code lock.
UsernameformstringNoThe username to logon to the code lock.
PasswordformstringNoThe password to logon to the code lock.
IntegrationTypeformstringNoThe integration type to the code lock. 1 = Local Api, 2 = Cloud Based Api
CreatedformdatetimeNoWhen settings was created
UpdatedformdatetimeNoWhen settings was updated

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /codelock/siedle/settings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","ApiEndpoint":"String","ApiPort":"String","DeviceId":"String","IntegrationType":"LocalApi","Username":"String","Password":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ApiEndpoint":"String","ApiPort":0,"DeviceId":"String","Username":"String","Password":"String","IntegrationType":"LocalApi"}