BokaMera.API.Host

HomepageSettingsQuery

The following routes are available for this service:
GET	/homepage/settings	Get the homepage settings for the company


export class HomepageTemplateResponse
{
    /** @description The template id */
    // @ApiMember(Description="The template id")
    public Id: number;

    /** @description The template name */
    // @ApiMember(Description="The template name")
    public Name: string;

    /** @description The template description */
    // @ApiMember(Description="The template description")
    public Description: string;

    /** @description The template image url */
    // @ApiMember(Description="The template image url")
    public ImageUrl: string;

    public constructor(init?: Partial<HomepageTemplateResponse>) { (Object as any).assign(this, init); }
}

export class HomepageHeroSectionStyleResponse
{
    /** @description The hero section style id */
    // @ApiMember(Description="The hero section style id")
    public Id: number;

    /** @description The hero section style name */
    // @ApiMember(Description="The hero section style name")
    public Name: string;

    /** @description The hero section style description */
    // @ApiMember(Description="The hero section style description")
    public Description: string;

    public constructor(init?: Partial<HomepageHeroSectionStyleResponse>) { (Object as any).assign(this, init); }
}

export class HomepageSettingsQueryResponse
{
    /** @description The company id */
    // @ApiMember(Description="The company id")
    public CompanyId: string;

    /** @description The text for homepage heading */
    // @ApiMember(Description="The text for homepage heading")
    public HomepageHeading: string;

    /** @description The text for homepage startpage heading */
    // @ApiMember(Description="The text for homepage startpage heading")
    public WelcomePageHeading: string;

    /** @description The text for homepage startpage body */
    // @ApiMember(Description="The text for homepage startpage body")
    public WelcomePageBody: string;

    /** @description The text for homepage about us page heading */
    // @ApiMember(Description="The text for homepage about us page heading")
    public AboutUsPageHeading: string;

    /** @description The text for homepage about us page body */
    // @ApiMember(Description="The text for homepage about us page body")
    public AboutUsPageBody: string;

    /** @description The startpage image url */
    // @ApiMember(Description="The startpage image url")
    public ImageUrl: string;

    /** @description The template for the homepage */
    // @ApiMember(Description="The template for the homepage")
    public HomePageTemplateId: number;

    /** @description The hero section style for the homepage */
    // @ApiMember(Description="The hero section style for the homepage")
    public HeroSectionStyleId: number;

    /** @description Show rating on the page */
    // @ApiMember(Description="Show rating on the page")
    public ShowRating: boolean;

    /** @description Enable the BokaMera Homepage */
    // @ApiMember(Description="Enable the BokaMera Homepage")
    public EnableHomepage: boolean;

    /** @description Will show when the homepage settings was created, note it will only be shown if your logged in as admin for the company. */
    // @ApiMember(DataType="datetime", Description="Will show when the homepage settings was created, note it will only be shown if your logged in as admin for the company.")
    public Updated?: 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. */
    // @ApiMember(DataType="datetime", Description="Will show when the homepage settings was updated, note it will only be shown if your logged in as admin for the company.")
    public Created?: string;

    /** @description The homepage templates options to select from */
    // @ApiMember(DataType="boolean", Description="The homepage templates options to select from", ParameterType="query")
    public HomePageTemplateOptions: HomepageTemplateResponse[];

    /** @description The homepage hero section style options to select from */
    // @ApiMember(DataType="boolean", Description="The homepage hero section style options to select from", ParameterType="query")
    public HomepageHeroSectionStyleOptions: HomepageHeroSectionStyleResponse[];

    public constructor(init?: Partial<HomepageSettingsQueryResponse>) { (Object as any).assign(this, init); }
}

export class HomepageSettingsQuery implements ICompany, ICompanyRequest
{
    /** @description The company id, if empty will use the company id for the user you are logged in with. */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.", ParameterType="path")
    public CompanyId?: string;

    /** @description If you want to include the homepage template options to select from */
    // @ApiMember(DataType="boolean", Description="If you want to include the homepage template options to select from", ParameterType="query")
    public IncludeHomePageTemplateOptions: boolean;

    /** @description If you want to include the homepage hero section style options to select from */
    // @ApiMember(DataType="boolean", Description="If you want to include the homepage hero section style options to select from", ParameterType="query")
    public IncludeHomePageHeroSectionStyleOptions: boolean;

    /** @description The homeage sitepath. */
    // @ApiMember(Description="The homeage sitepath.")
    public SitePath: string;

    public constructor(init?: Partial<HomepageSettingsQuery>) { (Object as any).assign(this, init); }
}

TypeScript HomepageSettingsQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

HTTP/1.1 200 OK
Content-Type: application/json
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"}]}