BokaMera.API.Host

<back to all web services

HomepageWidgetSettingsQuery

The following routes are available for this service:
GET/homepage/widget/settingsGet homepage widget settingsGet homepage widget settings on the company of the currently logged in user, only administrators are allowed to update homepage menu.

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

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

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

    /** @description The layout code. */
    // @ApiMember(Description="The layout code.")
    public Code: string;

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

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

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

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

    /** @description The layout code. */
    // @ApiMember(Description="The layout code.")
    public Code: string;

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

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

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

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

    /** @description The layout code. */
    // @ApiMember(Description="The layout code.")
    public Code: string;

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

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

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

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

    /** @description The layout code. */
    // @ApiMember(Description="The layout code.")
    public Code: string;

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

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

    /** @description The service layouts id. */
    // @ApiMember(Description="The service layouts id.")
    public ServiceLayoutId: number;

    /** @description The time layouts id. */
    // @ApiMember(Description="The time layouts id.")
    public TimeLayoutId: number;

    /** @description The booking layouts id. */
    // @ApiMember(Description="The booking layouts id.")
    public BookingLayoutId: number;

    /** @description The primary color of the booking widget. */
    // @ApiMember(Description="The primary color of the booking widget.")
    public PrimaryColor: string;

    /** @description If you should show the service image in the booking widget. */
    // @ApiMember(Description="If you should show the service image in the booking widget.")
    public ShowServiceImage: boolean;

    /** @description If you should show the rebate code field in the booking widget. */
    // @ApiMember(Description="If you should show the rebate code field in the booking widget.")
    public ShowRebateCodeField: boolean;

    /** @description If you should show the next available time in the booking widget. */
    // @ApiMember(Description="If you should show the next available time in the booking widget.")
    public ShowNextAvailableTime: boolean;

    /** @description If you should show the create account option. */
    // @ApiMember(Description="If you should show the create account option.")
    public EnableCreateAccount: boolean;

    /** @description If you should show the login to account option. */
    // @ApiMember(Description="If you should show the login to account option.")
    public EnableLogin: boolean;

    /** @description If you should show the facebook login to account option. */
    // @ApiMember(Description="If you should show the facebook login to account option.")
    public EnableFacebookLogin: boolean;

    /** @description If you should show the direct booking option. This enables customer to book with entering contact information. */
    // @ApiMember(Description="If you should show the direct booking option. This enables customer to book with entering contact information.")
    public EnableDirectBooking: boolean;

    /** @description If the site should have dark theme or not. */
    // @ApiMember(Description="If the site should have dark theme or not.")
    public DarkTheme: boolean;

    /** @description If you should show the end time in the booking widget. */
    // @ApiMember(Description="If you should show the end time in the booking widget.")
    public ShowEndTime: boolean;

    /** @description What text to show on booked time slots. Default text is Booked */
    // @ApiMember(Description="What text to show on booked time slots. Default text is Booked")
    public BookedTimeSlotText: string;

    public ServiceLayoutOptions: HomepageWidgetServiceLayoutsResponse[];
    public TimeLayoutOptions: HomepageWidgetTimeLayoutsResponse[];
    public BookingLayoutOptions: HomepageWidgetBookingLayoutsResponse[];
    public BookingMethodOptions: HomepageWidgetBookingMethodsResponse[];

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

export class HomepageWidgetSettingsQuery 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.")
    public CompanyId?: string;

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

    /** @description If you want to include what service layout options to select from */
    // @ApiMember(Description="If you want to include what service layout options to select from")
    public IncludeServiceLayoutOptions: boolean;

    /** @description If you want to include what time layout options to select from */
    // @ApiMember(Description="If you want to include what time layout options to select from")
    public IncludeTimeLayoutOptions: boolean;

    /** @description If you want to include what booking layout options to select from */
    // @ApiMember(Description="If you want to include what booking layout options to select from")
    public IncludeBookingLayoutOptions: boolean;

    /** @description If you want to include what booking method options to select from */
    // @ApiMember(Description="If you want to include what booking method options to select from")
    public IncludeBookingMethodOptions: boolean;

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

TypeScript HomepageWidgetSettingsQuery DTOs

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: testapi.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>
  <TimeLayoutId>0</TimeLayoutId>
  <TimeLayoutOptions>
    <HomepageWidgetTimeLayoutsResponse>
      <Code>String</Code>
      <Description>String</Description>
      <Id>0</Id>
      <Name>String</Name>
    </HomepageWidgetTimeLayoutsResponse>
  </TimeLayoutOptions>
</HomepageWidgetSettingsQueryResponse>