| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /codelock/settings | Get code lock settings for the currently logged in user | Get code lock settings for 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 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.")
override 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")
open var IncludeCodeLockSystemOptions:Boolean? = null
}
open class CodeLockSettingResponse
{
open var CompanyId:UUID? = null
/**
* The system type of the code lock
*/
@ApiMember(DataType="int", Description="The system type of the code lock")
open var CodeLockSystemsId:Int? = null
/**
* If code lock sync is active
*/
@ApiMember(DataType="bool", Description="If code lock sync is active")
open 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.")
open 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.")
open var ValidAfterMinutes:Int? = null
/**
* If it should clean up old bookings after they have passed
*/
@ApiMember(DataType="boolean", Description="If it should clean up old bookings after they have passed")
open var DeleteOldBySchedule:Boolean? = null
/**
* If a notification should be sent by Email
*/
@ApiMember(DataType="boolean", Description="If a notification should be sent by Email")
open var SendEmailNotification:Boolean? = null
/**
* If a notification should be sent by SMS
*/
@ApiMember(DataType="boolean", Description="If a notification should be sent by SMS")
open 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")
open 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")
open var SMSNotificationTime:Int? = null
/**
* When settings was created
*/
@ApiMember(DataType="datetime", Description="When settings was created")
open var Created:Date? = null
/**
* When settings were updated
*/
@ApiMember(DataType="datetime", Description="When settings were updated")
open var Updated:Date? = null
/**
* The available code lock systems to choose from
*/
@ApiMember(Description="The available code lock systems to choose from")
open var CodeLockSystemOptions:ArrayList<CodeLockSystemResponse>? = null
}
open class CodeLockSystemResponse
{
/**
* The system type of the code lock
*/
@ApiMember(DataType="int", Description="The system type of the code lock")
open var Id:Int? = null
/**
* The name of the code lock system
*/
@ApiMember(DataType="string", Description="The name of the code lock system")
open var Name:String? = null
/**
* The description of the code lock system
*/
@ApiMember(DataType="string", Description="The description of the code lock system")
open var Description:String? = null
/**
* The logotype of the code lock system
*/
@ApiMember(Description="The logotype of the code lock system")
open var LogoType:Uri? = null
/**
* The supplier name of the code lock system
*/
@ApiMember(Description="The supplier name of the code lock system")
open var Supplier:String? = null
}
Kotlin CodeLockSettingQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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.bookmore.com Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"CodeLockSystemsId":0,"Active":false,"ValidBeforeMinutes":0,"ValidAfterMinutes":0,"DeleteOldBySchedule":false,"SendEmailNotification":false,"SendSMSNotification":false,"EmailNotificationTime":0,"SMSNotificationTime":0,"CodeLockSystemOptions":[{"Id":0,"Name":"String","Description":"String","Supplier":"String"}]}