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.
CodeLockSettingQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
IncludeCodeLockSystemOptionsquerybooleanNoIf you want to include code locks that is supported.
CodeLockSettingResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
CodeLockSystemsIdformintNoThe system type of the code lock
ActiveformboolNoIf code lock sync is active
ValidBeforeMinutesformintNoNumber of minutes the access should be valid before booking starts.
ValidAfterMinutesformintNoNumber of minutes the access should be valid after booking ends.
DeleteOldByScheduleformbooleanNoIf it should clean up old bookings after the passed
SendEmailNotificationformbooleanNoIf a notification should be sent by Email
SendSMSNotificationformbooleanNoIf a notification should be sent by SMS
EmailNotificationTimeformintNoHow long before the booking starts in minutes the notification should be sent
SMSNotificationTimeformintNoHow long before the booking starts in minutes the notification should be sent
CreatedformdatetimeNoWhen settings was created
UpdatedformdatetimeNoWhen settings was updated
CodeLockSystemOptionsformList<CodeLockSystemResponse>NoThe available code lock systems to choose from
CodeLockSystemResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe system type of the code lock
NameformstringNoThe name of the code lock system
DescriptionformstringNoThe description of the code lock system
LogoTypeformUriNoThe logotype of the code lock system
SupplierformstringNoThe 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>