BokaMera.API.Host

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/settings	Get code lock settings for the currently logged in user	Get code lock settings for the currently logged in user.

**CodeLockSettingQuery** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	query	Guid?	No	The company id, if empty will use the company id for the user you are logged in with.
IncludeCodeLockSystemOptions	query	boolean	No	If you want to include code locks that is supported.

**CodeLockSettingResponse** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	form	Guid	No
CodeLockSystemsId	form	int	No	The system type of the code lock
Active	form	bool	No	If code lock sync is active
ValidBeforeMinutes	form	int	No	Number of minutes the access should be valid before booking starts.
ValidAfterMinutes	form	int	No	Number of minutes the access should be valid after booking ends.
DeleteOldBySchedule	form	boolean	No	If it should clean up old bookings after the passed
SendEmailNotification	form	boolean	No	If a notification should be sent by Email
SendSMSNotification	form	boolean	No	If a notification should be sent by SMS
EmailNotificationTime	form	int	No	How long before the booking starts in minutes the notification should be sent
SMSNotificationTime	form	int	No	How long before the booking starts in minutes the notification should be sent
Created	form	datetime	No	When settings was created
Updated	form	datetime	No	When settings was updated
CodeLockSystemOptions	form	List<CodeLockSystemResponse>	No	The available code lock systems to choose from

**CodeLockSystemResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No	The system type of the code lock
Name	form	string	No	The name of the code lock system
Description	form	string	No	The description of the code lock system
LogoType	form	Uri	No	The logotype of the code lock system
Supplier	form	string	No	The supplier name of the code lock system

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>