BokaMera.API.Host

<back to all web services

UpdateSetting

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/settingsUpdate settings for the company of the currently logged in userUpdate settings for the company of the currently logged in user.
UpdateSetting Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
BookingStatusIdbodyintNo
ScheduleViewIdbodyintNo
BookingTemplateIdbodyintNo
CalendarTypeIdbodyintNo
AllowBookingOnUnbookedTimesbodyboolNo
SendEmailReminderbodybooleanNo
SendSmsReminderbodybooleanNo
SendEmailConfirmationbodybooleanNo
SendSmsConfirmationbodybooleanNo
EmailReminderTimebodyintNo
SmsReminderTimebodyintNo
MaxActiveBookingsbodyintNo
SendNotificationsbodyboolNo
SendNotificationsEmailbodystringNo
MessageTextbodystringNoMessage text field that could be used inside message templates using [MessageText].
EnableMobileAppbodyboolNo
ScheduleStartTimebodyTimeSpan?NoThe admin scheduler start time to show as default
ScheduleEndTimebodyTimeSpan?NoThe admin scheduler end time to show as default
ReceiptTemplatebodystringNoBooking receipt text.
ScheduleTimeSlotMinutesbodyint?NoThe admin scheduler minutes of each timeslot
ScheduleGroupResourcesbodybool?NoThe admin scheduler if each resources should be shown in a seperate group
SchedulerDisableHorizontalScrollingbodybooleanNoThe admin scheduler if the horizontal scrolling should be turned off
BookOnlyOnExistingCustomersbodybooleanNoIf it's only allowed for existing customers to book
AutoGenerateUniquePinCodebodybooleanNoIf a unique pin code should be generated for the customer
AutoCreateUserProfilebodybooleanNoIf a user profile should be created when customer is booking time. With the property customer can login.
FollowUpMessageTimebodyint?NoWhen follow up message should be sent in hours after the booking.
ShowFreeTimesLeftbodybool?No
FreeSpotTextsIdbodyint?No
EnableICalGroupBookingsbodybool?No
AgreementTemplatebodystringNoBooking 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#
ScheduleShowTimeExeptionsbodybool?No
EnableBookingsOnSameTimebodybool?No
ShowWeekNumberSettingIdbodyint?No
EnableShowBookedTimesbodybool?No
EnableSendFollowUpMessagebodybool?No
BookSpotUserResponseMinutesbodyintNo
IsBookSpotDirectlybodybooleanNo
BookSpotDirectlyTimeLeftMinutesbodyintNo
SendEmailNotificationQueuebodyintNo
SendSMSNotificationQueuebodybooleanNo
WeightedPricesbodybooleanNoIf you have different prices over different times per day and want it to calculate the weighted price for the booked time.
ShowMultiDayAsTimebodybooleanNo
ShowMultipleResourcesAsOnebodybooleanNo
SettingResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
BookingStatusIdformintNo
ScheduleViewIdformintNo
BookingTemplateIdformintNo
CalendarTypeIdformintNo
AllowBookingOnUnbookedTimesformbooleanNo
SendEmailReminderformbooleanNo
SendSmsReminderformbooleanNo
SendEmailConfirmationformbooleanNo
SendSmsConfirmationformbooleanNo
MessageTextformstringNoMessage text field that could be used inside message templates using [MessageText].
EmailReminderTimeformintNo
SmsReminderTimeformintNo
MaxActiveBookingsformintNo
SendNotificationsformbooleanNo
SendNotificationsEmailformstringNo
EnableMobileAppformbooleanNo
ScheduleStartTimeformTimeSpan?No
ScheduleEndTimeformbooleanNo
ScheduleGroupResourcesformbooleanNoThe admin scheduler if each resources should be shown in a seperate group
SchedulerDisableHorizontalScrollingformbooleanNoThe admin scheduler if the horizontal scrolling should be turned off
ReceiptTemplateformstringNo
ScheduleTimeSlotMinutesformintNo
ShowFreeTimesLeftformbooleanNo
FreeSpotTextsIdformintNo
EnableICalGroupBookingsformbooleanNo
AgreementTemplateformstringNoBooking 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#
ScheduleShowTimeExeptionsformbooleanNo
EnableBookingsOnSameTimeformbooleanNo
ShowWeekNumberSettingIdformintNo
EnableShowBookedTimesformbooleanNo
BookSpotUserResponseMinutesformNo
IsBookSpotDirectlyformNo
BookSpotDirectlyTimeLeftMinutesformNo
SendEmailNotificationQueueformNo
SendSMSNotificationQueueformNo
EnableSendFollowUpMessageformboolNo
FollowUpMessageTimeformintNoWhen follow up message should be sent in hours after the booking.
BookOnlyOnExistingCustomersformbooleanNoIf it's only allowed for existing customers to book
AutoGenerateUniquePinCodeformbooleanNoIf a unique pin code should be generated for the customer
AutoCreateUserProfileformbooleanNoIf a user profile should be created when customer is booking time. With the property customer can login.
ScheduleViewOptionsformList<ScheduleViewResponse>NoThe available schedule view options to choose from
WeekNumberOptionsformList<WeekNumberSettingResponse>NoThe available week number options to choose from
BookingTemplateOptionsformList<BookingTemplateResponse>NoThe booking template options to choose from
CalendarTypeOptionsformList<CalendarTypeResponse>NoThe calendar type options to choose from
BookingStatusOptionsformList<BookingStatusOptions>NoThe booking status options to choose from
FreeSpotTextOptionsformList<FreeSpotTextsResponse>NoThe free spot text options to choose from
WeightedPricesformbooleanNoIf you have different prices over different times per day and want it to calculate the weighted price for the booked time.
ShowMultiDayAsTimeformbooleanNo
ShowMultipleResourcesAsOneformbooleanNo
ScheduleViewResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
WeekNumberSettingResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
DescriptionformstringNo
BookingTemplateResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
DescriptionformstringNo
UsedByApplicationformstringNo
CalendarTypeResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
DescriptionformstringNo
ActiveformboolNo
BookingStatusOptions Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
DescriptionformstringNo
FreeSpotTextsResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
TextSingularformstringNo
TextPluralformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
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: text/csv
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}