Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
POST | /codelock/siedle/settings | Add settings for the code lock of the company of the currently logged in user | Add settings for code lock of the company of the currently logged in user. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | body | Guid? | No | The company id, if empty will use the company id for the user you are logged in with. |
ApiEndpoint | body | string | Yes | The api endpoint of the code lock |
ApiPort | body | string | Yes | The api port for the code lock. |
DeviceId | body | string | No | The device id to the code lock. |
IntegrationType | body | string | No | The integration type to the code lock. 1 = Local Api, 2 = Cloud Based Api |
Username | body | string | Yes | The username to logon to the code lock. |
Password | body | string | Yes | The password to logon to the code lock. |
Name | Value | |
---|---|---|
LocalApi | 1 | |
CloudBasedApi | 2 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | form | Guid | No | |
ApiEndpoint | form | string | No | The api endpoint of the code lock |
ApiPort | form | string | No | The api port for the code lock. |
DeviceId | form | string | No | The device id to the code lock. |
Username | form | string | No | The username to logon to the code lock. |
Password | form | string | No | The password to logon to the code lock. |
IntegrationType | form | string | No | The integration type to the code lock. 1 = Local Api, 2 = Cloud Based Api |
Created | form | datetime | No | When settings was created |
Updated | form | datetime | No | When settings was updated |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: api.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AddSiedleCodeLockSetting 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>
<DeviceId>String</DeviceId>
<IntegrationType>LocalApi</IntegrationType>
<Password>String</Password>
<Username>String</Username>
</AddSiedleCodeLockSetting>
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>