| GET | /homepage/widget/settings | Get homepage widget settings | Get 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 | query | Guid? | No | The company id, if empty will use the company id for the user you are logged in with. |
| SitePath | query | string | Yes | The homepage sitepath. |
| IncludeServiceLayoutOptions | query | bool | No | If you want to include what service layout options to select from |
| IncludeTimeLayoutOptions | query | bool | No | If you want to include what time layout options to select from |
| IncludeBookingLayoutOptions | query | bool | No | If you want to include what booking layout options to select from |
| IncludeBookingMethodOptions | query | bool | No | If you want to include what booking method options to select from |
| 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 .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /homepage/widget/settings HTTP/1.1 Host: api.bokamera.se Accept: text/jsv
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
}
]
}