| 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. |
|---|
namespace BokaMera.API.ServiceModel.Dtos
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
type SiedleIntegrationType =
| LocalApi = 1
| CloudBasedApi = 2
[<AllowNullLiteral>]
type CodeLockSiedleSettingResponse() =
member val CompanyId:Guid = new Guid() with get,set
///<summary>
///The api endpoint of the code lock
///</summary>
[<ApiMember(DataType="string", Description="The api endpoint of the code lock")>]
member val ApiEndpoint:String = null with get,set
///<summary>
///The api port for the code lock.
///</summary>
[<ApiMember(DataType="string", Description="The api port for the code lock.")>]
member val ApiPort:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///The device id to the code lock.
///</summary>
[<ApiMember(DataType="string", Description="The device id to the code lock.")>]
member val DeviceId:String = null with get,set
///<summary>
///The username to logon to the code lock.
///</summary>
[<ApiMember(DataType="string", Description="The username to logon to the code lock.")>]
member val Username:String = null with get,set
///<summary>
///The password to logon to the code lock.
///</summary>
[<ApiMember(DataType="string", Description="The password to logon to the code lock.")>]
member val Password:String = null with get,set
///<summary>
///The integration type to the code lock. 1 = Local Api, 2 = Cloud Based Api
///</summary>
[<ApiMember(DataType="string", Description="The integration type to the code lock. 1 = Local Api, 2 = Cloud Based Api")>]
member val IntegrationType:SiedleIntegrationType = new SiedleIntegrationType() with get,set
///<summary>
///When settings was created
///</summary>
[<ApiMember(DataType="datetime", Description="When settings was created")>]
member val Created:DateTime = new DateTime() with get,set
///<summary>
///When settings was updated
///</summary>
[<ApiMember(DataType="datetime", Description="When settings was updated")>]
member val Updated:DateTime = new DateTime() with get,set
[<ValidateRequest(Validator="IsAuthenticated")>]
[<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
[<ApiResponse(Description="You have too low privileges to call this service", StatusCode=403)>]
[<AllowNullLiteral>]
type AddSiedleCodeLockSetting() =
///<summary>
///The company id, if empty will use the company id for the user you are logged in with.
///</summary>
[<ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")>]
member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///The api endpoint of the code lock
///</summary>
[<ApiMember(DataType="string", Description="The api endpoint of the code lock", IsRequired=true)>]
member val ApiEndpoint:String = null with get,set
///<summary>
///The api port for the code lock.
///</summary>
[<ApiMember(DataType="string", Description="The api port for the code lock.", IsRequired=true)>]
member val ApiPort:String = null with get,set
///<summary>
///The device id to the code lock.
///</summary>
[<ApiMember(DataType="string", Description="The device id to the code lock.")>]
member val DeviceId:String = null with get,set
///<summary>
///The integration type to the code lock. 1 = Local Api, 2 = Cloud Based Api
///</summary>
[<ApiMember(DataType="string", Description="The integration type to the code lock. 1 = Local Api, 2 = Cloud Based Api")>]
member val IntegrationType:SiedleIntegrationType = new SiedleIntegrationType() with get,set
///<summary>
///The username to logon to the code lock.
///</summary>
[<ApiMember(DataType="string", Description="The username to logon to the code lock.", IsRequired=true)>]
member val Username:String = null with get,set
///<summary>
///The password to logon to the code lock.
///</summary>
[<ApiMember(DataType="string", Description="The password to logon to the code lock.", IsRequired=true)>]
member val Password:String = null with get,set
F# AddSiedleCodeLockSetting DTOs
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: testapi.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>