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.

export class CodeLockSystemResponse
{
    /** @description The system type of the code lock */
    // @ApiMember(DataType="int", Description="The system type of the code lock")
    public Id: number;

    /** @description The name of the code lock system */
    // @ApiMember(DataType="string", Description="The name of the code lock system")
    public Name: string;

    /** @description The description of the code lock system */
    // @ApiMember(DataType="string", Description="The description of the code lock system")
    public Description: string;

    /** @description The logotype of the code lock system */
    // @ApiMember(Description="The logotype of the code lock system")
    public LogoType: string;

    /** @description The supplier name of the code lock system */
    // @ApiMember(Description="The supplier name of the code lock system")
    public Supplier: string;

    public constructor(init?: Partial<CodeLockSystemResponse>) { (Object as any).assign(this, init); }
}

export class CodeLockSettingResponse
{
    public CompanyId: string;
    /** @description The system type of the code lock */
    // @ApiMember(DataType="int", Description="The system type of the code lock")
    public CodeLockSystemsId: number;

    /** @description If code lock sync is active */
    // @ApiMember(DataType="bool", Description="If code lock sync is active")
    public Active: boolean;

    /** @description 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.")
    public ValidBeforeMinutes: number;

    /** @description 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.")
    public ValidAfterMinutes: number;

    /** @description If it should clean up old bookings after the passed */
    // @ApiMember(DataType="boolean", Description="If it should clean up old bookings after the passed")
    public DeleteOldBySchedule: boolean;

    /** @description If a notification should be sent by Email */
    // @ApiMember(DataType="boolean", Description="If a notification should be sent by Email")
    public SendEmailNotification: boolean;

    /** @description If a notification should be sent by SMS */
    // @ApiMember(DataType="boolean", Description="If a notification should be sent by SMS")
    public SendSMSNotification: boolean;

    /** @description 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")
    public EmailNotificationTime: number;

    /** @description 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")
    public SMSNotificationTime: number;

    /** @description When settings was created */
    // @ApiMember(DataType="datetime", Description="When settings was created")
    public Created: string;

    /** @description When settings was updated */
    // @ApiMember(DataType="datetime", Description="When settings was updated")
    public Updated: string;

    /** @description The available code lock systems to choose from */
    // @ApiMember(Description="The available code lock systems to choose from")
    public CodeLockSystemOptions: CodeLockSystemResponse[];

    public constructor(init?: Partial<CodeLockSettingResponse>) { (Object as any).assign(this, init); }
}

// @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)
export class CodeLockSettingQuery implements ICompany
{
    /** @description 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 CompanyId?: string;

    /** @description 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")
    public IncludeCodeLockSystemOptions: boolean;

    public constructor(init?: Partial<CodeLockSettingQuery>) { (Object as any).assign(this, init); }
}

TypeScript 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>