| GET | /homepage/settings | Get the homepage settings for the company |
|---|
"use strict";
export class HomepageTemplateResponse {
/** @param {{Id?:number,Name?:string,Description?:string,ImageUrl?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The template id */
Id;
/**
* @type {string}
* @description The template name */
Name;
/**
* @type {string}
* @description The template description */
Description;
/**
* @type {string}
* @description The template image url */
ImageUrl;
}
export class HomepageHeroSectionStyleResponse {
/** @param {{Id?:number,Name?:string,Description?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The hero section style id */
Id;
/**
* @type {string}
* @description The hero section style name */
Name;
/**
* @type {string}
* @description The hero section style description */
Description;
}
export class HomepageSettingsQueryResponse {
/** @param {{CompanyId?:string,HomepageHeading?:string,WelcomePageHeading?:string,WelcomePageBody?:string,AboutUsPageHeading?:string,AboutUsPageBody?:string,ImageUrl?:string,HomePageTemplateId?:number,HeroSectionStyleId?:number,ShowRating?:boolean,EnableHomepage?:boolean,Updated?:string,Created?:string,HomePageTemplateOptions?:HomepageTemplateResponse[],HomepageHeroSectionStyleOptions?:HomepageHeroSectionStyleResponse[]}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The company id */
CompanyId;
/**
* @type {string}
* @description The text for homepage heading */
HomepageHeading;
/**
* @type {string}
* @description The text for homepage startpage heading */
WelcomePageHeading;
/**
* @type {string}
* @description The text for homepage startpage body */
WelcomePageBody;
/**
* @type {string}
* @description The text for homepage about us page heading */
AboutUsPageHeading;
/**
* @type {string}
* @description The text for homepage about us page body */
AboutUsPageBody;
/**
* @type {string}
* @description The startpage image url */
ImageUrl;
/**
* @type {number}
* @description The template for the homepage */
HomePageTemplateId;
/**
* @type {number}
* @description The hero section style for the homepage */
HeroSectionStyleId;
/**
* @type {boolean}
* @description Show rating on the page */
ShowRating;
/**
* @type {boolean}
* @description Enable the BokaMera Homepage */
EnableHomepage;
/**
* @type {?string}
* @description Will show when the homepage settings was created, note it will only be shown if your logged in as admin for the company. */
Updated;
/**
* @type {?string}
* @description Will show when the homepage settings was updated, note it will only be shown if your logged in as admin for the company. */
Created;
/**
* @type {HomepageTemplateResponse[]}
* @description The homepage templates options to select from */
HomePageTemplateOptions;
/**
* @type {HomepageHeroSectionStyleResponse[]}
* @description The homepage hero section style options to select from */
HomepageHeroSectionStyleOptions;
}
export class HomepageSettingsQuery {
/** @param {{CompanyId?:string,IncludeHomePageTemplateOptions?:boolean,IncludeHomePageHeroSectionStyleOptions?:boolean,SitePath?:string}} [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 {boolean}
* @description If you want to include the homepage template options to select from */
IncludeHomePageTemplateOptions;
/**
* @type {boolean}
* @description If you want to include the homepage hero section style options to select from */
IncludeHomePageHeroSectionStyleOptions;
/**
* @type {string}
* @description The homeage sitepath. */
SitePath;
}
JavaScript HomepageSettingsQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /homepage/settings HTTP/1.1 Host: testapi.bokamera.se Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"HomepageHeading":"String","WelcomePageHeading":"String","WelcomePageBody":"String","AboutUsPageHeading":"String","AboutUsPageBody":"String","HomePageTemplateId":0,"HeroSectionStyleId":0,"ShowRating":false,"EnableHomepage":false,"Updated":"0001-01-01T00:00:00","Created":"0001-01-01T00:00:00","HomePageTemplateOptions":[{"Id":0,"Name":"String","Description":"String"}],"HomepageHeroSectionStyleOptions":[{"Id":0,"Name":"String","Description":"String"}]}