BokaMera.API.Host

<back to all web services

AddAxemaCodeLockSetting

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/codelock/axema/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.
AddAxemaCodeLockSetting 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.
UsernamebodystringYesThe username to logon to the code lock.
PasswordbodystringYesThe password to logon to the code lock.
CodeLockAxemaSettingResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
ApiEndpointformstringNoThe api endpoint of the code lock
ApiPortformstringNoThe api port for the code lock.
UsernameformstringNoThe username to logon to the code lock.
PasswordformstringNoThe password to logon to the code lock.
CreatedformdatetimeNoWhen settings was created
UpdatedformdatetimeNoWhen settings was updated

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

HTTP + CSV

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

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

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

{"ApiEndpoint":"String","ApiPort":0,"Username":"String","Password":"String"}