BokaMera.API.Host

HomepageWidgetSettingsQuery

The following routes are available for this service:
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.

**HomepageWidgetSettingsQuery** Parameters:
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	No	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

**HomepageWidgetSettingsQueryResponse** Parameters:
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

**HomepageWidgetServiceLayoutsResponse** Parameters:
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.

**HomepageWidgetTimeLayoutsResponse** Parameters:
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.

**HomepageWidgetBookingLayoutsResponse** Parameters:
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.

**HomepageWidgetBookingMethodsResponse** Parameters:
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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml

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>