| 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. |
|---|
| 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. |
| 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 they have 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 were updated |
| CodeLockSystemOptions | form | List<CodeLockSystemResponse> | Yes | The available code lock systems to choose from |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | The system type of the code lock |
| Name | form | string | Yes | The name of the code lock system |
| Description | form | string | Yes | The description of the code lock system |
| LogoType | form | Uri | Yes | The logotype of the code lock system |
| Supplier | form | string | Yes | The supplier name of the code lock system |
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.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"}]}