BokaMera.API.Host

<back to all web services

UpdateHomepageWidgetSettings

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/homepage/widget/settingsUpdate homepage widget settingsUpdate homepage widget settings on the company of the currently logged in user, only administrators are allowed to update homepage menu.
UpdateHomepageWidgetSettings Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
ServiceLayoutIdbodyint?NoSerivce Layout.
TimeLayoutIdbodyint?NoTime Layout.
BookingLayoutIdbodyint?NoBooking Layout.
PrimaryColorbodystringNoThe primary color of the booking widget.
DarkThemebodybool?NoIf the site should have dark theme or not.
ShowServiceImagebodybool?NoIf you should show the service image in the booking widget.
ShowRebateCodeFieldbodybool?NoIf you should show the rebate code field in the booking widget.
ShowNextAvailableTimebodybool?NoIf you should show the next available time in the booking widget.
ShowEndTimebodybool?NoIf you should show the end time in the booking widget.
ShowSubscribeToNewsletterbodybool?NoShow subscribe to newsletter checkbox on the page
BookedTimeSlotTextbodystringNoWhat text to show on booked time slots. Default text is Booked
EnableCreateAccountbodybool?NoIf you should show the create account option.
EnableLoginbodybool?NoIf you should show the login to account option.
EnableFacebookLoginbodybool?NoIf you should show the facebook login to account option.
EnableDirectBookingbodybool?NoIf you should show the direct booking option. This enables customer to book with entering contact information.
HomepageWidgetSettingsQueryResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNoThe company id.
ServiceLayoutIdformintNoThe service layouts id.
TimeLayoutIdformintNoThe time layouts id.
BookingLayoutIdformintNoThe booking layouts id.
PrimaryColorformstringNoThe primary color of the booking widget.
ShowServiceImageformboolNoIf you should show the service image in the booking widget.
ShowRebateCodeFieldformboolNoIf you should show the rebate code field in the booking widget.
ShowNextAvailableTimeformboolNoIf you should show the next available time in the booking widget.
ShowSubscribeToNewsletterformboolNoIf you should show the subscribe to newsletter checkbox in the booking widget.
EnableCreateAccountformboolNoIf you should show the create account option.
EnableLoginformboolNoIf you should show the login to account option.
EnableFacebookLoginformboolNoIf you should show the facebook login to account option.
EnableDirectBookingformboolNoIf you should show the direct booking option. This enables customer to book with entering contact information.
DarkThemeformboolNoIf the site should have dark theme or not.
ShowEndTimeformboolNoIf you should show the end time in the booking widget.
BookedTimeSlotTextformstringNoWhat text to show on booked time slots. Default text is Booked
ServiceLayoutOptionsformList<HomepageWidgetServiceLayoutsResponse>No
TimeLayoutOptionsformList<HomepageWidgetTimeLayoutsResponse>No
BookingLayoutOptionsformList<HomepageWidgetBookingLayoutsResponse>No
BookingMethodOptionsformList<HomepageWidgetBookingMethodsResponse>No
HomepageWidgetServiceLayoutsResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe layout id.
NameformstringNoThe layout name.
DescriptionformstringNoThe layout description.
CodeformstringNoThe layout code.
HomepageWidgetTimeLayoutsResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe layout id.
NameformstringNoThe layout name.
DescriptionformstringNoThe layout description.
CodeformstringNoThe layout code.
HomepageWidgetBookingLayoutsResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe layout id.
NameformstringNoThe layout name.
DescriptionformstringNoThe layout description.
CodeformstringNoThe layout code.
HomepageWidgetBookingMethodsResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe layout id.
NameformstringNoThe layout name.
DescriptionformstringNoThe layout description.
CodeformstringNoThe layout code.

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.

PUT /homepage/widget/settings HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	ServiceLayoutId: 0,
	TimeLayoutId: 0,
	BookingLayoutId: 0,
	PrimaryColor: String,
	DarkTheme: False,
	ShowServiceImage: False,
	ShowRebateCodeField: False,
	ShowNextAvailableTime: False,
	ShowEndTime: False,
	ShowSubscribeToNewsletter: False,
	BookedTimeSlotText: String,
	EnableCreateAccount: False,
	EnableLogin: False,
	EnableFacebookLogin: False,
	EnableDirectBooking: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ServiceLayoutId: 0,
	TimeLayoutId: 0,
	BookingLayoutId: 0,
	PrimaryColor: String,
	ShowServiceImage: False,
	ShowRebateCodeField: False,
	ShowNextAvailableTime: False,
	ShowSubscribeToNewsletter: False,
	EnableCreateAccount: False,
	EnableLogin: False,
	EnableFacebookLogin: False,
	EnableDirectBooking: False,
	DarkTheme: False,
	ShowEndTime: False,
	BookedTimeSlotText: String,
	ServiceLayoutOptions: 
	[
		{
			Id: 0,
			Name: String,
			Description: String,
			Code: String
		}
	],
	TimeLayoutOptions: 
	[
		{
			Id: 0,
			Name: String,
			Description: String,
			Code: String
		}
	],
	BookingLayoutOptions: 
	[
		{
			Id: 0,
			Name: String,
			Description: String,
			Code: String
		}
	],
	BookingMethodOptions: 
	[
		{
			Id: 0,
			Name: String,
			Description: String,
			Code: String
		}
	]
}