| 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 | Yes | 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 | Yes | 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 | Yes | 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 | Yes | What text to show on booked time slots. Default text is Booked |
| ServiceLayoutOptions | form | List<HomepageWidgetServiceLayoutsResponse> | Yes | |
| TimeLayoutOptions | form | List<HomepageWidgetTimeLayoutsResponse> | Yes | |
| BookingLayoutOptions | form | List<HomepageWidgetBookingLayoutsResponse> | Yes | |
| BookingMethodOptions | form | List<HomepageWidgetBookingMethodsResponse> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | The layout id. |
| Name | form | string | Yes | The layout name. |
| Description | form | string | Yes | The layout description. |
| Code | form | string | Yes | The layout code. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | The layout id. |
| Name | form | string | Yes | The layout name. |
| Description | form | string | Yes | The layout description. |
| Code | form | string | Yes | The layout code. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | The layout id. |
| Name | form | string | Yes | The layout name. |
| Description | form | string | Yes | The layout description. |
| Code | form | string | Yes | The layout code. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | The layout id. |
| Name | form | string | Yes | The layout name. |
| Description | form | string | Yes | The layout description. |
| Code | form | string | Yes | The layout code. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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.bookmore.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateHomepageWidgetSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<BookedTimeSlotText>String</BookedTimeSlotText>
<BookingLayoutId>0</BookingLayoutId>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<DarkTheme>false</DarkTheme>
<EnableCreateAccount>false</EnableCreateAccount>
<EnableDirectBooking>false</EnableDirectBooking>
<EnableFacebookLogin>false</EnableFacebookLogin>
<EnableLogin>false</EnableLogin>
<PrimaryColor>String</PrimaryColor>
<ServiceLayoutId>0</ServiceLayoutId>
<ShowEndTime>false</ShowEndTime>
<ShowNextAvailableTime>false</ShowNextAvailableTime>
<ShowRebateCodeField>false</ShowRebateCodeField>
<ShowServiceImage>false</ShowServiceImage>
<ShowSubscribeToNewsletter>false</ShowSubscribeToNewsletter>
<TimeLayoutId>0</TimeLayoutId>
</UpdateHomepageWidgetSettings>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<HomepageWidgetSettingsQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<BookedTimeSlotText>String</BookedTimeSlotText>
<BookingLayoutId>0</BookingLayoutId>
<BookingLayoutOptions>
<HomepageWidgetBookingLayoutsResponse>
<Code>String</Code>
<Description>String</Description>
<Id>0</Id>
<Name>String</Name>
</HomepageWidgetBookingLayoutsResponse>
</BookingLayoutOptions>
<BookingMethodOptions>
<HomepageWidgetBookingMethodsResponse>
<Code>String</Code>
<Description>String</Description>
<Id>0</Id>
<Name>String</Name>
</HomepageWidgetBookingMethodsResponse>
</BookingMethodOptions>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<DarkTheme>false</DarkTheme>
<EnableCreateAccount>false</EnableCreateAccount>
<EnableDirectBooking>false</EnableDirectBooking>
<EnableFacebookLogin>false</EnableFacebookLogin>
<EnableLogin>false</EnableLogin>
<PrimaryColor>String</PrimaryColor>
<ServiceLayoutId>0</ServiceLayoutId>
<ServiceLayoutOptions>
<HomepageWidgetServiceLayoutsResponse>
<Code>String</Code>
<Description>String</Description>
<Id>0</Id>
<Name>String</Name>
</HomepageWidgetServiceLayoutsResponse>
</ServiceLayoutOptions>
<ShowEndTime>false</ShowEndTime>
<ShowNextAvailableTime>false</ShowNextAvailableTime>
<ShowRebateCodeField>false</ShowRebateCodeField>
<ShowServiceImage>false</ShowServiceImage>
<ShowSubscribeToNewsletter>false</ShowSubscribeToNewsletter>
<TimeLayoutId>0</TimeLayoutId>
<TimeLayoutOptions>
<HomepageWidgetTimeLayoutsResponse>
<Code>String</Code>
<Description>String</Description>
<Id>0</Id>
<Name>String</Name>
</HomepageWidgetTimeLayoutsResponse>
</TimeLayoutOptions>
</HomepageWidgetSettingsQueryResponse>