| 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. |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
@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)
open class AddSiedleCodeLockSetting : ICompany
{
/**
* The company id, if empty will use the company id for the user you are logged in with.
*/
@ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
override var CompanyId:UUID? = null
/**
* The api endpoint of the code lock
*/
@ApiMember(DataType="string", Description="The api endpoint of the code lock", IsRequired=true)
open var ApiEndpoint:String? = null
/**
* The api port for the code lock.
*/
@ApiMember(DataType="string", Description="The api port for the code lock.", IsRequired=true)
open var ApiPort:String? = null
/**
* The device id to the code lock.
*/
@ApiMember(DataType="string", Description="The device id to the code lock.")
open var DeviceId:String? = null
/**
* The integration type to the code lock. 1 = Local Api, 2 = Cloud Based Api
*/
@ApiMember(DataType="string", Description="The integration type to the code lock. 1 = Local Api, 2 = Cloud Based Api")
open var IntegrationType:SiedleIntegrationType? = null
/**
* The username to logon to the code lock.
*/
@ApiMember(DataType="string", Description="The username to logon to the code lock.", IsRequired=true)
open var Username:String? = null
/**
* The password to logon to the code lock.
*/
@ApiMember(DataType="string", Description="The password to logon to the code lock.", IsRequired=true)
open var Password:String? = null
}
enum class SiedleIntegrationType(val value:Int)
{
LocalApi(1),
CloudBasedApi(2),
}
open class CodeLockSiedleSettingResponse
{
open var CompanyId:UUID? = null
/**
* The api endpoint of the code lock
*/
@ApiMember(DataType="string", Description="The api endpoint of the code lock")
open var ApiEndpoint:String? = null
/**
* The api port for the code lock.
*/
@ApiMember(DataType="string", Description="The api port for the code lock.")
open var ApiPort:Int? = null
/**
* The device id to the code lock.
*/
@ApiMember(DataType="string", Description="The device id to the code lock.")
open var DeviceId:String? = null
/**
* The username to logon to the code lock.
*/
@ApiMember(DataType="string", Description="The username to logon to the code lock.")
open var Username:String? = null
/**
* The password to logon to the code lock.
*/
@ApiMember(DataType="string", Description="The password to logon to the code lock.")
open var Password:String? = null
/**
* The integration type to the code lock. 1 = Local Api, 2 = Cloud Based Api
*/
@ApiMember(DataType="string", Description="The integration type to the code lock. 1 = Local Api, 2 = Cloud Based Api")
open var IntegrationType:SiedleIntegrationType? = null
/**
* When settings was created
*/
@ApiMember(DataType="datetime", Description="When settings was created")
open var Created:Date? = null
/**
* When settings was updated
*/
@ApiMember(DataType="datetime", Description="When settings was updated")
open var Updated:Date? = null
}
Kotlin 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: api.bookmore.com
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>