| 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. |
|---|
"use strict";
export class HomepageWidgetServiceLayoutsResponse {
/** @param {{Id?:number,Name?:string,Description?:string,Code?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The layout id. */
Id;
/**
* @type {string}
* @description The layout name. */
Name;
/**
* @type {string}
* @description The layout description. */
Description;
/**
* @type {string}
* @description The layout code. */
Code;
}
export class HomepageWidgetTimeLayoutsResponse {
/** @param {{Id?:number,Name?:string,Description?:string,Code?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The layout id. */
Id;
/**
* @type {string}
* @description The layout name. */
Name;
/**
* @type {string}
* @description The layout description. */
Description;
/**
* @type {string}
* @description The layout code. */
Code;
}
export class HomepageWidgetBookingLayoutsResponse {
/** @param {{Id?:number,Name?:string,Description?:string,Code?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The layout id. */
Id;
/**
* @type {string}
* @description The layout name. */
Name;
/**
* @type {string}
* @description The layout description. */
Description;
/**
* @type {string}
* @description The layout code. */
Code;
}
export class HomepageWidgetBookingMethodsResponse {
/** @param {{Id?:number,Name?:string,Description?:string,Code?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The layout id. */
Id;
/**
* @type {string}
* @description The layout name. */
Name;
/**
* @type {string}
* @description The layout description. */
Description;
/**
* @type {string}
* @description The layout code. */
Code;
}
export class HomepageWidgetSettingsQueryResponse {
/** @param {{CompanyId?:string,ServiceLayoutId?:number,TimeLayoutId?:number,BookingLayoutId?:number,PrimaryColor?:string,ShowServiceImage?:boolean,ShowRebateCodeField?:boolean,ShowNextAvailableTime?:boolean,ShowSubscribeToNewsletter?:boolean,EnableCreateAccount?:boolean,EnableLogin?:boolean,EnableFacebookLogin?:boolean,EnableDirectBooking?:boolean,DarkTheme?:boolean,ShowEndTime?:boolean,BookedTimeSlotText?:string,ServiceLayoutOptions?:HomepageWidgetServiceLayoutsResponse[],TimeLayoutOptions?:HomepageWidgetTimeLayoutsResponse[],BookingLayoutOptions?:HomepageWidgetBookingLayoutsResponse[],BookingMethodOptions?:HomepageWidgetBookingMethodsResponse[]}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The company id. */
CompanyId;
/**
* @type {number}
* @description The service layouts id. */
ServiceLayoutId;
/**
* @type {number}
* @description The time layouts id. */
TimeLayoutId;
/**
* @type {number}
* @description The booking layouts id. */
BookingLayoutId;
/**
* @type {string}
* @description The primary color of the booking widget. */
PrimaryColor;
/**
* @type {boolean}
* @description If you should show the service image in the booking widget. */
ShowServiceImage;
/**
* @type {boolean}
* @description If you should show the rebate code field in the booking widget. */
ShowRebateCodeField;
/**
* @type {boolean}
* @description If you should show the next available time in the booking widget. */
ShowNextAvailableTime;
/**
* @type {boolean}
* @description If you should show the subscribe to newsletter checkbox in the booking widget. */
ShowSubscribeToNewsletter;
/**
* @type {boolean}
* @description If you should show the create account option. */
EnableCreateAccount;
/**
* @type {boolean}
* @description If you should show the login to account option. */
EnableLogin;
/**
* @type {boolean}
* @description If you should show the facebook login to account option. */
EnableFacebookLogin;
/**
* @type {boolean}
* @description If you should show the direct booking option. This enables customer to book with entering contact information. */
EnableDirectBooking;
/**
* @type {boolean}
* @description If the site should have dark theme or not. */
DarkTheme;
/**
* @type {boolean}
* @description If you should show the end time in the booking widget. */
ShowEndTime;
/**
* @type {string}
* @description What text to show on booked time slots. Default text is Booked */
BookedTimeSlotText;
/** @type {HomepageWidgetServiceLayoutsResponse[]} */
ServiceLayoutOptions;
/** @type {HomepageWidgetTimeLayoutsResponse[]} */
TimeLayoutOptions;
/** @type {HomepageWidgetBookingLayoutsResponse[]} */
BookingLayoutOptions;
/** @type {HomepageWidgetBookingMethodsResponse[]} */
BookingMethodOptions;
}
export class HomepageWidgetSettingsQuery {
/** @param {{CompanyId?:string,SitePath?:string,IncludeServiceLayoutOptions?:boolean,IncludeTimeLayoutOptions?:boolean,IncludeBookingLayoutOptions?:boolean,IncludeBookingMethodOptions?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {?string}
* @description The company id, if empty will use the company id for the user you are logged in with. */
CompanyId;
/**
* @type {string}
* @description The homepage sitepath. */
SitePath;
/**
* @type {boolean}
* @description If you want to include what service layout options to select from */
IncludeServiceLayoutOptions;
/**
* @type {boolean}
* @description If you want to include what time layout options to select from */
IncludeTimeLayoutOptions;
/**
* @type {boolean}
* @description If you want to include what booking layout options to select from */
IncludeBookingLayoutOptions;
/**
* @type {boolean}
* @description If you want to include what booking method options to select from */
IncludeBookingMethodOptions;
}
JavaScript HomepageWidgetSettingsQuery DTOs
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.
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>