BokaMera.API.Host

<back to all web services

UpdateSiedleCodeLockSetting

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/codelock/siedle/settingsUpdate settings for the code lock of the company of the currently logged in userUpdate settings for code lock of the company of 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 UpdateSiedleCodeLockSetting : 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?

    /**
    * 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: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

    /**
    * 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

    required public init(){}
}

public enum SiedleIntegrationType : Int, Codable
{
    case LocalApi = 1
    case CloudBasedApi = 2
}

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(){}
}


Swift UpdateSiedleCodeLockSetting DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /codelock/siedle/settings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","ApiEndpoint":"String","ApiPort":"String","IntegrationType":"LocalApi","DeviceId":"String","Username":"String","Password":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ApiEndpoint":"String","ApiPort":0,"DeviceId":"String","Username":"String","Password":"String","IntegrationType":"LocalApi"}