BokaMera.API.Host

<back to all web services

HomepageSettingsQuery

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 homepage sitepath. */
    // @ApiMember(Description="The homepage sitepath.")
    public SitePath: string;

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

TypeScript HomepageSettingsQuery DTOs

GET /homepage/settings HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<HomepageSettingsQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <AboutUsPageBody>String</AboutUsPageBody>
  <AboutUsPageHeading>String</AboutUsPageHeading>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Created>0001-01-01T00:00:00</Created>
  <EnableHomepage>false</EnableHomepage>
  <HeroSectionStyleId>0</HeroSectionStyleId>
  <HomePageTemplateId>0</HomePageTemplateId>
  <HomePageTemplateOptions>
    <HomepageTemplateResponse>
      <Description>String</Description>
      <Id>0</Id>
      <ImageUrl i:nil="true" />
      <Name>String</Name>
    </HomepageTemplateResponse>
  </HomePageTemplateOptions>
  <HomepageHeading>String</HomepageHeading>
  <HomepageHeroSectionStyleOptions>
    <HomepageHeroSectionStyleResponse>
      <Description>String</Description>
      <Id>0</Id>
      <Name>String</Name>
    </HomepageHeroSectionStyleResponse>
  </HomepageHeroSectionStyleOptions>
  <ImageUrl i:nil="true" />
  <ShowRating>false</ShowRating>
  <Updated>0001-01-01T00:00:00</Updated>
  <WelcomePageBody>String</WelcomePageBody>
  <WelcomePageHeading>String</WelcomePageHeading>
</HomepageSettingsQueryResponse>