Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
PUT | /settings | Update settings for the company of the currently logged in user | Update settings for the company of the currently logged in user. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | body | Guid? | No | The company id, if empty will use the company id for the user you are logged in with. |
BookingStatusId | body | int | No | |
ScheduleViewId | body | int | No | |
BookingTemplateId | body | int | No | |
CalendarTypeId | body | int | No | |
AllowBookingOnUnbookedTimes | body | bool | No | |
SendEmailReminder | body | boolean | No | |
SendSmsReminder | body | boolean | No | |
SendEmailConfirmation | body | boolean | No | |
SendSmsConfirmation | body | boolean | No | |
EmailReminderTime | body | int | No | |
SmsReminderTime | body | int | No | |
MaxActiveBookings | body | int | No | |
SendNotifications | body | bool | No | |
SendNotificationsEmail | body | string | No | |
MessageText | body | string | No | Message text field that could be used inside message templates using [MessageText]. |
EnableMobileApp | body | bool | No | |
ScheduleStartTime | body | TimeSpan? | No | The admin scheduler start time to show as default |
ScheduleEndTime | body | TimeSpan? | No | The admin scheduler end time to show as default |
ReceiptTemplate | body | string | No | Booking receipt text. |
ScheduleTimeSlotMinutes | body | int? | No | The admin scheduler minutes of each timeslot |
ScheduleGroupResources | body | bool? | No | The admin scheduler if each resources should be shown in a seperate group |
SchedulerDisableHorizontalScrolling | body | boolean | No | The admin scheduler if the horizontal scrolling should be turned off |
BookOnlyOnExistingCustomers | body | boolean | No | If it's only allowed for existing customers to book |
AutoGenerateUniquePinCode | body | boolean | No | If a unique pin code should be generated for the customer |
AutoCreateUserProfile | body | boolean | No | If a user profile should be created when customer is booking time. With the property customer can login. |
FollowUpMessageTime | body | int? | No | When follow up message should be sent in hours after the booking. |
ShowFreeTimesLeft | body | bool? | No | |
FreeSpotTextsId | body | int? | No | |
EnableICalGroupBookings | body | bool? | No | |
AgreementTemplate | body | string | No | Booking agreement text. All html needs to entered using markup. Read about markup here https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet. Use this editor to create markup https://stackedit.io/app# |
ScheduleShowTimeExeptions | body | bool? | No | |
EnableBookingsOnSameTime | body | bool? | No | |
ShowWeekNumberSettingId | body | int? | No | |
EnableShowBookedTimes | body | bool? | No | |
EnableSendFollowUpMessage | body | bool? | No | |
BookSpotUserResponseMinutes | body | int | No | |
IsBookSpotDirectly | body | boolean | No | |
BookSpotDirectlyTimeLeftMinutes | body | int | No | |
SendEmailNotificationQueue | body | int | No | |
SendSMSNotificationQueue | body | boolean | No | |
WeightedPrices | body | boolean | No | If you have different prices over different times per day and want it to calculate the weighted price for the booked time. |
ShowMultiDayAsTime | body | boolean | No | |
ShowMultipleResourcesAsOne | body | boolean | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | form | Guid | No | |
BookingStatusId | form | int | No | |
ScheduleViewId | form | int | No | |
BookingTemplateId | form | int | No | |
CalendarTypeId | form | int | No | |
AllowBookingOnUnbookedTimes | form | boolean | No | |
SendEmailReminder | form | boolean | No | |
SendSmsReminder | form | boolean | No | |
SendEmailConfirmation | form | boolean | No | |
SendSmsConfirmation | form | boolean | No | |
MessageText | form | string | No | Message text field that could be used inside message templates using [MessageText]. |
EmailReminderTime | form | int | No | |
SmsReminderTime | form | int | No | |
MaxActiveBookings | form | int | No | |
SendNotifications | form | boolean | No | |
SendNotificationsEmail | form | string | No | |
EnableMobileApp | form | boolean | No | |
ScheduleStartTime | form | TimeSpan? | No | |
ScheduleEndTime | form | boolean | No | |
ScheduleGroupResources | form | boolean | No | The admin scheduler if each resources should be shown in a seperate group |
SchedulerDisableHorizontalScrolling | form | boolean | No | The admin scheduler if the horizontal scrolling should be turned off |
ReceiptTemplate | form | string | No | |
ScheduleTimeSlotMinutes | form | int | No | |
ShowFreeTimesLeft | form | boolean | No | |
FreeSpotTextsId | form | int | No | |
EnableICalGroupBookings | form | boolean | No | |
AgreementTemplate | form | string | No | Booking agreement text. All html needs to entered using markup. Read about markup here https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet. Use this editor to create markup https://stackedit.io/app# |
ScheduleShowTimeExeptions | form | boolean | No | |
EnableBookingsOnSameTime | form | boolean | No | |
ShowWeekNumberSettingId | form | int | No | |
EnableShowBookedTimes | form | boolean | No | |
BookSpotUserResponseMinutes | form | No | ||
IsBookSpotDirectly | form | No | ||
BookSpotDirectlyTimeLeftMinutes | form | No | ||
SendEmailNotificationQueue | form | No | ||
SendSMSNotificationQueue | form | No | ||
EnableSendFollowUpMessage | form | bool | No | |
FollowUpMessageTime | form | int | No | When follow up message should be sent in hours after the booking. |
BookOnlyOnExistingCustomers | form | boolean | No | If it's only allowed for existing customers to book |
AutoGenerateUniquePinCode | form | boolean | No | If a unique pin code should be generated for the customer |
AutoCreateUserProfile | form | boolean | No | If a user profile should be created when customer is booking time. With the property customer can login. |
ScheduleViewOptions | form | List<ScheduleViewResponse> | No | The available schedule view options to choose from |
WeekNumberOptions | form | List<WeekNumberSettingResponse> | No | The available week number options to choose from |
BookingTemplateOptions | form | List<BookingTemplateResponse> | No | The booking template options to choose from |
CalendarTypeOptions | form | List<CalendarTypeResponse> | No | The calendar type options to choose from |
BookingStatusOptions | form | List<BookingStatusOptions> | No | The booking status options to choose from |
FreeSpotTextOptions | form | List<FreeSpotTextsResponse> | No | The free spot text options to choose from |
WeightedPrices | form | boolean | No | If you have different prices over different times per day and want it to calculate the weighted price for the booked time. |
ShowMultiDayAsTime | form | boolean | No | |
ShowMultipleResourcesAsOne | form | boolean | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Name | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Name | form | string | No | |
Description | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Name | form | string | No | |
Description | form | string | No | |
UsedByApplication | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Name | form | string | No | |
Description | form | string | No | |
Active | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Name | form | string | No | |
Description | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
TextSingular | form | string | No | |
TextPlural | form | string | No |
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /settings HTTP/1.1
Host: api.bokamera.se
Accept: application/json
Content-Type: application/json
Content-Length: length
{"CompanyId":"00000000-0000-0000-0000-000000000000","BookingStatusId":0,"ScheduleViewId":0,"BookingTemplateId":0,"CalendarTypeId":0,"AllowBookingOnUnbookedTimes":false,"SendEmailReminder":false,"SendSmsReminder":false,"SendEmailConfirmation":false,"SendSmsConfirmation":false,"EmailReminderTime":0,"SmsReminderTime":0,"MaxActiveBookings":0,"SendNotifications":false,"SendNotificationsEmail":"String","MessageText":"String","EnableMobileApp":false,"ScheduleStartTime":"00:00:00","ScheduleEndTime":"00:00:00","ReceiptTemplate":"String","ScheduleTimeSlotMinutes":0,"ScheduleGroupResources":false,"SchedulerDisableHorizontalScrolling":false,"BookOnlyOnExistingCustomers":false,"AutoGenerateUniquePinCode":false,"AutoCreateUserProfile":false,"FollowUpMessageTime":0,"ShowFreeTimesLeft":false,"FreeSpotTextsId":0,"EnableICalGroupBookings":false,"AgreementTemplate":"String","ScheduleShowTimeExeptions":false,"EnableBookingsOnSameTime":false,"ShowWeekNumberSettingId":0,"EnableShowBookedTimes":false,"EnableSendFollowUpMessage":false,"BookSpotUserResponseMinutes":0,"IsBookSpotDirectly":false,"BookSpotDirectlyTimeLeftMinutes":0,"SendEmailNotificationQueue":false,"SendSMSNotificationQueue":false,"WeightedPrices":false,"ShowMultiDayAsTime":false,"ShowMultipleResourcesAsOne":false}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"BookingStatusId":0,"ScheduleViewId":0,"BookingTemplateId":0,"CalendarTypeId":0,"AllowBookingOnUnbookedTimes":false,"SendEmailReminder":false,"SendSmsReminder":false,"SendEmailConfirmation":false,"SendSmsConfirmation":false,"MessageText":"String","EmailReminderTime":0,"SmsReminderTime":0,"MaxActiveBookings":0,"SendNotifications":false,"SendNotificationsEmail":"String","EnableMobileApp":false,"ScheduleStartTime":"00:00:00","ScheduleEndTime":"00:00:00","ScheduleGroupResources":false,"SchedulerDisableHorizontalScrolling":false,"ReceiptTemplate":"String","ScheduleTimeSlotMinutes":0,"ShowFreeTimesLeft":false,"FreeSpotTextsId":0,"EnableICalGroupBookings":false,"AgreementTemplate":"String","ScheduleShowTimeExeptions":false,"EnableBookingsOnSameTime":false,"ShowWeekNumberSettingId":0,"EnableShowBookedTimes":false,"BookSpotUserResponseMinutes":0,"IsBookSpotDirectly":false,"BookSpotDirectlyTimeLeftMinutes":0,"SendEmailNotificationQueue":false,"SendSMSNotificationQueue":false,"EnableSendFollowUpMessage":false,"FollowUpMessageTime":0,"BookOnlyOnExistingCustomers":false,"AutoGenerateUniquePinCode":false,"AutoCreateUserProfile":false,"ScheduleViewOptions":[{"Id":0,"Name":"String"}],"WeekNumberOptions":[{"Id":0,"Name":"String","Description":"String"}],"BookingTemplateOptions":[{"Id":0,"Name":"String","Description":"String","UsedByApplication":"String"}],"CalendarTypeOptions":[{"Id":0,"Name":"String","Description":"String","Active":false}],"BookingStatusOptions":[{"Id":0,"Name":"String","Description":"String"}],"FreeSpotTextOptions":[{"Id":0,"TextSingular":"String","TextPlural":"String"}],"WeightedPrices":false,"ShowMultiDayAsTime":false,"ShowMultipleResourcesAsOne":false}