Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
PUT | /homepage/widget/settings | Update homepage widget settings | Update homepage widget settings on the company of the currently logged in user, only administrators are allowed to update homepage menu. |
---|
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. |
ServiceLayoutId | body | int? | No | Serivce Layout. |
TimeLayoutId | body | int? | No | Time Layout. |
BookingLayoutId | body | int? | No | Booking Layout. |
PrimaryColor | body | string | No | The primary color of the booking widget. |
DarkTheme | body | bool? | No | If the site should have dark theme or not. |
ShowServiceImage | body | bool? | No | If you should show the service image in the booking widget. |
ShowRebateCodeField | body | bool? | No | If you should show the rebate code field in the booking widget. |
ShowNextAvailableTime | body | bool? | No | If you should show the next available time in the booking widget. |
ShowEndTime | body | bool? | No | If you should show the end time in the booking widget. |
ShowSubscribeToNewsletter | body | bool? | No | Show subscribe to newsletter checkbox on the page |
BookedTimeSlotText | body | string | No | What text to show on booked time slots. Default text is Booked |
EnableCreateAccount | body | bool? | No | If you should show the create account option. |
EnableLogin | body | bool? | No | If you should show the login to account option. |
EnableFacebookLogin | body | bool? | No | If you should show the facebook login to account option. |
EnableDirectBooking | body | bool? | No | If you should show the direct booking option. This enables customer to book with entering contact information. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | form | Guid | No | The company id. |
ServiceLayoutId | form | int | No | The service layouts id. |
TimeLayoutId | form | int | No | The time layouts id. |
BookingLayoutId | form | int | No | The booking layouts id. |
PrimaryColor | form | string | No | The primary color of the booking widget. |
ShowServiceImage | form | bool | No | If you should show the service image in the booking widget. |
ShowRebateCodeField | form | bool | No | If you should show the rebate code field in the booking widget. |
ShowNextAvailableTime | form | bool | No | If you should show the next available time in the booking widget. |
ShowSubscribeToNewsletter | form | bool | No | If you should show the subscribe to newsletter checkbox in the booking widget. |
EnableCreateAccount | form | bool | No | If you should show the create account option. |
EnableLogin | form | bool | No | If you should show the login to account option. |
EnableFacebookLogin | form | bool | No | If you should show the facebook login to account option. |
EnableDirectBooking | form | bool | No | If you should show the direct booking option. This enables customer to book with entering contact information. |
DarkTheme | form | bool | No | If the site should have dark theme or not. |
ShowEndTime | form | bool | No | If you should show the end time in the booking widget. |
BookedTimeSlotText | form | string | No | What text to show on booked time slots. Default text is Booked |
ServiceLayoutOptions | form | List<HomepageWidgetServiceLayoutsResponse> | No | |
TimeLayoutOptions | form | List<HomepageWidgetTimeLayoutsResponse> | No | |
BookingLayoutOptions | form | List<HomepageWidgetBookingLayoutsResponse> | No | |
BookingMethodOptions | form | List<HomepageWidgetBookingMethodsResponse> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | The layout id. |
Name | form | string | No | The layout name. |
Description | form | string | No | The layout description. |
Code | form | string | No | The layout code. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | The layout id. |
Name | form | string | No | The layout name. |
Description | form | string | No | The layout description. |
Code | form | string | No | The layout code. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | The layout id. |
Name | form | string | No | The layout name. |
Description | form | string | No | The layout description. |
Code | form | string | No | The layout code. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | The layout id. |
Name | form | string | No | The layout name. |
Description | form | string | No | The layout description. |
Code | form | string | No | The layout code. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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 } ] }