Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
GET | /codelock/siedle/settings | Get code lock api settings for the currently logged in user | Get code lock api settings for the currently logged in user. |
---|
import Foundation
import ServiceStack
// @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)
public class CodeLockSiedleSettingQuery : ICompany, Codable
{
/**
* 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.")
public var companyId:String?
required public init(){}
}
public class CodeLockSiedleSettingResponse : Codable
{
public var companyId:String
/**
* The api endpoint of the code lock
*/
// @ApiMember(DataType="string", Description="The api endpoint of the code lock")
public var apiEndpoint:String
/**
* The api port for the code lock.
*/
// @ApiMember(DataType="string", Description="The api port for the code lock.")
public var apiPort:Int?
/**
* The device id to the code lock.
*/
// @ApiMember(DataType="string", Description="The device id to the code lock.")
public var deviceId:String
/**
* The username to logon to the code lock.
*/
// @ApiMember(DataType="string", Description="The username to logon to the code lock.")
public var username:String
/**
* The password to logon to the code lock.
*/
// @ApiMember(DataType="string", Description="The password to logon to the code lock.")
public var password:String
/**
* 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")
public var integrationType:SiedleIntegrationType
/**
* When settings was created
*/
// @ApiMember(DataType="datetime", Description="When settings was created")
public var created:Date
/**
* When settings was updated
*/
// @ApiMember(DataType="datetime", Description="When settings was updated")
public var updated:Date
required public init(){}
}
public enum SiedleIntegrationType : Int, Codable
{
case LocalApi = 1
case CloudBasedApi = 2
}
Swift CodeLockSiedleSettingQuery 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.
GET /codelock/siedle/settings HTTP/1.1 Host: api.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>