BokaMera.API.Host

<back to all web services

CodeLockSiedleSettingQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/codelock/siedle/settingsGet code lock api settings for the currently logged in userGet code lock api settings for the currently logged in user.
CodeLockSiedleSettingQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
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
SiedleIntegrationType Enum:
NameValue
LocalApi1
CloudBasedApi2

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.

GET /codelock/siedle/settings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CodeLockSiedleSettingResponse 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>
  <DeviceId>String</DeviceId>
  <IntegrationType>LocalApi</IntegrationType>
  <Password>String</Password>
  <Updated>0001-01-01T00:00:00</Updated>
  <Username>String</Username>
</CodeLockSiedleSettingResponse>