BokaMera.API.Host

<back to all web services

CodeLockSettingQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/codelock/settingsGet code lock settings for the currently logged in userGet code lock settings for 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 CodeLockSettingQuery : 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

    /**
    * If you want to include code locks that is supported.
    */
    @ApiMember(DataType="boolean", Description="If you want to include code locks that is supported.", ParameterType="query")
    var IncludeCodeLockSystemOptions:Boolean? = null
}

open class CodeLockSettingResponse
{
    var CompanyId:UUID? = null
    /**
    * The system type of the code lock
    */
    @ApiMember(DataType="int", Description="The system type of the code lock")
    var CodeLockSystemsId:Int? = null

    /**
    * If code lock sync is active
    */
    @ApiMember(DataType="bool", Description="If code lock sync is active")
    var Active:Boolean? = null

    /**
    * Number of minutes the access should be valid before booking starts.
    */
    @ApiMember(DataType="int", Description="Number of minutes the access should be valid before booking starts.")
    var ValidBeforeMinutes:Int? = null

    /**
    * Number of minutes the access should be valid after booking ends.
    */
    @ApiMember(DataType="int", Description="Number of minutes the access should be valid after booking ends.")
    var ValidAfterMinutes:Int? = null

    /**
    * If it should clean up old bookings after the passed
    */
    @ApiMember(DataType="boolean", Description="If it should clean up old bookings after the passed")
    var DeleteOldBySchedule:Boolean? = null

    /**
    * If a notification should be sent by Email
    */
    @ApiMember(DataType="boolean", Description="If a notification should be sent by Email")
    var SendEmailNotification:Boolean? = null

    /**
    * If a notification should be sent by SMS
    */
    @ApiMember(DataType="boolean", Description="If a notification should be sent by SMS")
    var SendSMSNotification:Boolean? = null

    /**
    * How long before the booking starts in minutes the notification should be sent
    */
    @ApiMember(DataType="int", Description="How long before the booking starts in minutes the notification should be sent")
    var EmailNotificationTime:Int? = null

    /**
    * How long before the booking starts in minutes the notification should be sent
    */
    @ApiMember(DataType="int", Description="How long before the booking starts in minutes the notification should be sent")
    var SMSNotificationTime:Int? = 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

    /**
    * The available code lock systems to choose from
    */
    @ApiMember(Description="The available code lock systems to choose from")
    var CodeLockSystemOptions:ArrayList<CodeLockSystemResponse> = ArrayList<CodeLockSystemResponse>()
}

open class CodeLockSystemResponse
{
    /**
    * The system type of the code lock
    */
    @ApiMember(DataType="int", Description="The system type of the code lock")
    var Id:Int? = null

    /**
    * The name of the code lock system
    */
    @ApiMember(DataType="string", Description="The name of the code lock system")
    var Name:String? = null

    /**
    * The description of the code lock system
    */
    @ApiMember(DataType="string", Description="The description of the code lock system")
    var Description:String? = null

    /**
    * The logotype of the code lock system
    */
    @ApiMember(Description="The logotype of the code lock system")
    var LogoType:Uri? = null

    /**
    * The supplier name of the code lock system
    */
    @ApiMember(Description="The supplier name of the code lock system")
    var Supplier:String? = null
}

Kotlin CodeLockSettingQuery DTOs

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

HTTP + XML

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

GET /codelock/settings HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CodeLockSettingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Active>false</Active>
  <CodeLockSystemOptions>
    <CodeLockSystemResponse>
      <Description>String</Description>
      <Id>0</Id>
      <LogoType i:nil="true" />
      <Name>String</Name>
      <Supplier>String</Supplier>
    </CodeLockSystemResponse>
  </CodeLockSystemOptions>
  <CodeLockSystemsId>0</CodeLockSystemsId>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Created>0001-01-01T00:00:00</Created>
  <DeleteOldBySchedule>false</DeleteOldBySchedule>
  <EmailNotificationTime>0</EmailNotificationTime>
  <SMSNotificationTime>0</SMSNotificationTime>
  <SendEmailNotification>false</SendEmailNotification>
  <SendSMSNotification>false</SendSMSNotification>
  <Updated>0001-01-01T00:00:00</Updated>
  <ValidAfterMinutes>0</ValidAfterMinutes>
  <ValidBeforeMinutes>0</ValidBeforeMinutes>
</CodeLockSettingResponse>