BokaMera.API.Host

<back to all web services

UpdateAxemaCodeLockSetting

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/codelock/axema/settingsUpdate settings for the code lock of the company of the currently logged in userUpdate settings for code lock of the company of the currently logged in user.
UpdateAxemaCodeLockSetting Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
ApiEndpointbodystringNoThe api endpoint of the code lock
ApiPortbodystringNoThe api port for the code lock.
UsernamebodystringNoThe username to logon to the code lock.
PasswordbodystringNoThe 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 .xml suffix or ?format=xml

HTTP + XML

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

PUT /codelock/axema/settings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateAxemaCodeLockSetting xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ApiEndpoint>String</ApiEndpoint>
  <ApiPort>String</ApiPort>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Password>String</Password>
  <Username>String</Username>
</UpdateAxemaCodeLockSetting>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CodeLockAxemaSettingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ApiEndpoint>String</ApiEndpoint>
  <ApiPort>0</ApiPort>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Created>0001-01-01T00:00:00</Created>
  <Password>String</Password>
  <Updated>0001-01-01T00:00:00</Updated>
  <Username>String</Username>
</CodeLockAxemaSettingResponse>