BokaMera.API.Host

<back to all web services

SettingQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/settingsGet settings for the currently logged in userGet settings for the currently logged in user.
SettingQuery Parameters:
NameParameterData TypeRequiredDescription
IncludeScheduleViewOptionsquerybooleanNoIf you want to include the schedule views to select from
IncludeWeekNumberOptionsquerybooleanNoIf you want to include the week number settings to select from
IncludeBookingTemplateOptionsquerybooleanNoIf you want to include the booking template options to select from
IncludeCalendarTypeOptionsquerybooleanNoIf you want to include the calendar type options to select from
IncludeBookingStatusOptionsquerybooleanNoIf you want to include the booking status options to select from
IncludeFreeSpotTextOptionsquerybooleanNoIf you want to include the Free spot text options to select from
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 .other suffix or ?format=other

HTTP + OTHER

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

GET /settings HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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}