BokaMera.API.Host

<back to all web services

AddSiedleCodeLockSetting

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/codelock/siedle/settingsAdd settings for the code lock of the company of the currently logged in userAdd settings for code lock of the company of the currently logged in user.
import java.math.*
import java.util.*
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.")
    var CompanyId:UUID? = null

    /**
    * The api endpoint of the code lock
    */
    @ApiMember(DataType="string", Description="The api endpoint of the code lock", IsRequired=true)
    var ApiEndpoint:String? = null

    /**
    * The api port for the code lock.
    */
    @ApiMember(DataType="string", Description="The api port for the code lock.", IsRequired=true)
    var ApiPort:String? = null

    /**
    * The device id to the code lock.
    */
    @ApiMember(DataType="string", Description="The device id to the code lock.")
    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")
    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)
    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)
    var Password:String? = null
}

enum class SiedleIntegrationType(val value:Int)
{
    LocalApi(1),
    CloudBasedApi(2),
}

open class CodeLockSiedleSettingResponse
{
    var CompanyId:UUID? = null
    /**
    * The api endpoint of the code lock
    */
    @ApiMember(DataType="string", Description="The api endpoint of the code lock")
    var ApiEndpoint:String? = null

    /**
    * The api port for the code lock.
    */
    @ApiMember(DataType="string", Description="The api port for the code lock.")
    var ApiPort:Int? = null

    /**
    * The device id to the code lock.
    */
    @ApiMember(DataType="string", Description="The device id to the code lock.")
    var DeviceId:String? = null

    /**
    * The username to logon to the code lock.
    */
    @ApiMember(DataType="string", Description="The username to logon to the code lock.")
    var Username:String? = null

    /**
    * The password to logon to the code lock.
    */
    @ApiMember(DataType="string", Description="The password to logon to the code lock.")
    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")
    var IntegrationType:SiedleIntegrationType? = null

    /**
    * When settings was created
    */
    @ApiMember(DataType="datetime", Description="When settings was created")
    var Created:Date? = null

    /**
    * When settings was updated
    */
    @ApiMember(DataType="datetime", Description="When settings was updated")
    var Updated:Date? = null
}

Kotlin AddSiedleCodeLockSetting DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

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

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