BokaMera.API.Host

<back to all web services

UpdateCodeLockSetting

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/codelock/settingsUpdate settings for the code locks of the company of the currently logged in userUpdate settings for code lock of the company of the currently logged in user.
UpdateCodeLockSetting Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
ActivebodyboolNoIf code lock sync is active
CodeLockSystemsIdbodyintNoThe system type of the code lock
ValidBeforeMinutesbodyintNoNumber of minutes the access should be valid before booking starts.
ValidAfterMinutesbodyintNoNumber of minutes the access should be valid after booking ends.
DeleteOldBySchedulebodybooleanNoIf it should clean up old bookings after the passed
SendEmailNotificationbodybooleanNoIf a notification should be sent by Email
SendSMSNotificationbodybooleanNoIf a notification should be sent by SMS
EmailNotificationTimebodyintNoHow long before the booking starts in minutes the notification should be sent
SMSNotificationTimebodyintNoHow long before the booking starts in minutes the notification should be sent
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /codelock/settings HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Active":false,"CodeLockSystemsId":0,"ValidBeforeMinutes":0,"ValidAfterMinutes":0,"DeleteOldBySchedule":false,"SendEmailNotification":false,"SendSMSNotification":false,"EmailNotificationTime":0,"SMSNotificationTime":0}
HTTP/1.1 200 OK
Content-Type: application/json
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"}]}