| 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. |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
namespace BokaMera.API.ServiceModel.Dtos
{
[ValidateRequest("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 partial class CodeLockSettingQuery
: ICompany
{
///<summary>
///The company id, if empty will use the company id for the user you are logged in with.
///</summary>
[ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")]
public virtual Guid? CompanyId { get; set; }
///<summary>
///If you want to include code locks that is supported.
///</summary>
[ApiMember(DataType="boolean", Description="If you want to include code locks that is supported.", ParameterType="query")]
public virtual bool IncludeCodeLockSystemOptions { get; set; }
}
public partial class CodeLockSettingResponse
{
public CodeLockSettingResponse()
{
CodeLockSystemOptions = new List<CodeLockSystemResponse>{};
}
public virtual Guid CompanyId { get; set; }
///<summary>
///The system type of the code lock
///</summary>
[ApiMember(DataType="int", Description="The system type of the code lock")]
public virtual int CodeLockSystemsId { get; set; }
///<summary>
///If code lock sync is active
///</summary>
[ApiMember(DataType="bool", Description="If code lock sync is active")]
public virtual bool Active { get; set; }
///<summary>
///Number of minutes the access should be valid before booking starts.
///</summary>
[ApiMember(DataType="int", Description="Number of minutes the access should be valid before booking starts.")]
public virtual int ValidBeforeMinutes { get; set; }
///<summary>
///Number of minutes the access should be valid after booking ends.
///</summary>
[ApiMember(DataType="int", Description="Number of minutes the access should be valid after booking ends.")]
public virtual int ValidAfterMinutes { get; set; }
///<summary>
///If it should clean up old bookings after the passed
///</summary>
[ApiMember(DataType="boolean", Description="If it should clean up old bookings after the passed")]
public virtual bool DeleteOldBySchedule { get; set; }
///<summary>
///If a notification should be sent by Email
///</summary>
[ApiMember(DataType="boolean", Description="If a notification should be sent by Email")]
public virtual bool SendEmailNotification { get; set; }
///<summary>
///If a notification should be sent by SMS
///</summary>
[ApiMember(DataType="boolean", Description="If a notification should be sent by SMS")]
public virtual bool SendSMSNotification { get; set; }
///<summary>
///How long before the booking starts in minutes the notification should be sent
///</summary>
[ApiMember(DataType="int", Description="How long before the booking starts in minutes the notification should be sent")]
public virtual int EmailNotificationTime { get; set; }
///<summary>
///How long before the booking starts in minutes the notification should be sent
///</summary>
[ApiMember(DataType="int", Description="How long before the booking starts in minutes the notification should be sent")]
public virtual int SMSNotificationTime { get; set; }
///<summary>
///When settings was created
///</summary>
[ApiMember(DataType="datetime", Description="When settings was created")]
public virtual DateTime Created { get; set; }
///<summary>
///When settings was updated
///</summary>
[ApiMember(DataType="datetime", Description="When settings was updated")]
public virtual DateTime Updated { get; set; }
///<summary>
///The available code lock systems to choose from
///</summary>
[ApiMember(Description="The available code lock systems to choose from")]
public virtual List<CodeLockSystemResponse> CodeLockSystemOptions { get; set; }
}
public partial class CodeLockSystemResponse
{
///<summary>
///The system type of the code lock
///</summary>
[ApiMember(DataType="int", Description="The system type of the code lock")]
public virtual int Id { get; set; }
///<summary>
///The name of the code lock system
///</summary>
[ApiMember(DataType="string", Description="The name of the code lock system")]
public virtual string Name { get; set; }
///<summary>
///The description of the code lock system
///</summary>
[ApiMember(DataType="string", Description="The description of the code lock system")]
public virtual string Description { get; set; }
///<summary>
///The logotype of the code lock system
///</summary>
[ApiMember(Description="The logotype of the code lock system")]
public virtual Uri LogoType { get; set; }
///<summary>
///The supplier name of the code lock system
///</summary>
[ApiMember(Description="The supplier name of the code lock system")]
public virtual string Supplier { get; set; }
}
}
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: testapi.bokamera.se 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"}]}