BokaMera.API.Host

BookingSettingQuery

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read

The following routes are available for this service:
GET	/settings	Get settings for the currently logged in user	Get settings for the currently logged in user.

**BookingSettingQuery** Parameters:
Name	Parameter	Data Type	Required	Description
IncludeScheduleViewOptions	query	boolean	No	If you want to include the schedule views to select from
IncludeWeekNumberOptions	query	boolean	No	If you want to include the week number settings to select from
IncludeBookingTemplateOptions	query	boolean	No	If you want to include the booking template options to select from
IncludeCalendarTypeOptions	query	boolean	No	If you want to include the calendar type options to select from
IncludeBookingStatusOptions	query	boolean	No	If you want to include the booking status options to select from
IncludeFreeSpotTextOptions	query	boolean	No	If you want to include the Free spot text options to select from

**BookingSettingResponse** Parameters:
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
SendPushNotification	form	boolean	No	If the customer should receive Push notification when booked
SendPushNotificationReminder	form	boolean	No	If the customer should receive Push notification reminders on bookings
PushNotificationReminderTime	form	int	No	How many minutes before booking starts the customer should receive the notification
MessageText	form	string	Yes	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	Yes
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 separate group
SchedulerDisableHorizontalScrolling	form	boolean	No	The admin scheduler if the horizontal scrolling should be turned off
ReceiptTemplate	form	string	Yes
ScheduleTimeSlotMinutes	form	int	No
ShowFreeTimesLeft	form	boolean	No
FreeSpotTextsId	form	int	No
EnableICalGroupBookings	form	boolean	No
AgreementTemplate	form	string	Yes	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>	Yes	The available schedule view options to choose from
WeekNumberOptions	form	List<WeekNumberSettingResponse>	Yes	The available week number options to choose from
BookingTemplateOptions	form	List<BookingTemplateResponse>	Yes	The booking template options to choose from
CalendarTypeOptions	form	List<CalendarTypeResponse>	Yes	The calendar type options to choose from
BookingStatusOptions	form	List<BookingStatusOptions>	Yes	The booking status options to choose from
FreeSpotTextOptions	form	List<FreeSpotTextsResponse>	Yes	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
BookingPinCodeRestriction	form	string	Yes	If booking should be restricted by a pin code
CustomerInvoiceAdressRequired	form	bool	No	If checked customer invoice will be required when creating booking

**ScheduleViewResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No
Name	form	string	Yes

**WeekNumberSettingResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	Yes
Description	form	string	Yes

**BookingTemplateResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	Yes
Description	form	string	Yes
UsedByApplication	form	string	Yes

**CalendarTypeResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	Yes
Description	form	string	Yes
Active	form	bool	No

**BookingStatusOptions** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	Yes
Description	form	string	Yes

**FreeSpotTextsResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
TextSingular	form	string	Yes
TextPlural	form	string	Yes

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

HTTP + JSV

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/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	BookingStatusId: 0,
	ScheduleViewId: 0,
	BookingTemplateId: 0,
	CalendarTypeId: 0,
	AllowBookingOnUnbookedTimes: False,
	SendEmailReminder: False,
	SendSmsReminder: False,
	SendEmailConfirmation: False,
	SendSmsConfirmation: False,
	SendPushNotification: False,
	SendPushNotificationReminder: False,
	PushNotificationReminderTime: 0,
	MessageText: String,
	EmailReminderTime: 0,
	SmsReminderTime: 0,
	MaxActiveBookings: 0,
	SendNotifications: False,
	SendNotificationsEmail: String,
	EnableMobileApp: False,
	ScheduleStartTime: PT0S,
	ScheduleEndTime: PT0S,
	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,
	BookingPinCodeRestriction: String,
	CustomerInvoiceAdressRequired: False
}