BokaMera.API.Host

<back to all web services

HomepageMenuQuery

The following routes are available for this service:
GET/homepage/menuFind news items for a company

// @DataContract
export class QueryBase
{
    /** @description Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code> */
    // @DataMember(Order=1)
    public Skip?: number;

    /** @description Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code> */
    // @DataMember(Order=2)
    public Take?: number;

    /** @description Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code> */
    // @DataMember(Order=3)
    public OrderBy: string;

    /** @description Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code> */
    // @DataMember(Order=4)
    public OrderByDesc: string;

    /** @description Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code> */
    // @DataMember(Order=5)
    public Include: string;

    // @DataMember(Order=6)
    public Fields: string;

    // @DataMember(Order=7)
    public Meta: { [index: string]: string; };

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

export class QueryDb<From, Into> extends QueryBase
{

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

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

    /** @description The text for home menu item */
    // @ApiMember(Description="The text for home menu item")
    public HomeText: string;

    /** @description If the home menu item should be hidden */
    // @ApiMember(Description="If the home menu item should be hidden")
    public HomeHidden: boolean;

    /** @description The text for services menu item */
    // @ApiMember(Description="The text for services menu item")
    public ServicesText: string;

    /** @description If the services menu item should be hidden */
    // @ApiMember(Description="If the services menu item should be hidden")
    public ServicesHidden: boolean;

    /** @description The text for book time menu item */
    // @ApiMember(Description="The text for book time menu item")
    public BookTimeText: string;

    /** @description If the book time menu item should be hidden */
    // @ApiMember(Description="If the book time menu item should be hidden")
    public BookTimeHidden: boolean;

    /** @description The text for about us menu item */
    // @ApiMember(Description="The text for about us menu item")
    public AboutUsText: string;

    /** @description If the about us menu item should be hidden */
    // @ApiMember(Description="If the about us menu item should be hidden")
    public AboutUsHidden: boolean;

    /** @description The text for contact us menu item */
    // @ApiMember(Description="The text for contact us menu item")
    public ContactUsText: string;

    /** @description If the contact us menu item should be hidden */
    // @ApiMember(Description="If the contact us menu item should be hidden")
    public ContactUsHidden: boolean;

    /** @description The text for my bookings menu item */
    // @ApiMember(Description="The text for my bookings menu item")
    public MyBookingsText: string;

    /** @description If the my bookings menu item should be hidden */
    // @ApiMember(Description="If the my bookings menu item should be hidden")
    public MyBookingsHidden: boolean;

    /** @description The text for calender menu item */
    // @ApiMember(Description="The text for calender menu item")
    public CalendarText: string;

    /** @description If the calendar menu item should be hidden */
    // @ApiMember(Description="If the calendar menu item should be hidden")
    public CalendarHidden: boolean;

    /** @description The text for news menu item */
    // @ApiMember(Description="The text for news menu item")
    public NewsText: string;

    /** @description If the news menu item should be hidden */
    // @ApiMember(Description="If the news menu item should be hidden")
    public NewsHidden: boolean;

    /** @description The text for address menu item */
    // @ApiMember(Description="The text for address menu item")
    public AddressText: string;

    /** @description If the address menu item should be hidden */
    // @ApiMember(Description="If the address menu item should be hidden")
    public AddressHidden?: boolean;

    /** @description The text for gallery menu item */
    // @ApiMember(Description="The text for gallery menu item")
    public GalleryText: string;

    /** @description If the gallery menu item should be hidden */
    // @ApiMember(Description="If the gallery menu item should be hidden")
    public GalleryHidden?: boolean;

    public ResponseStatus: ResponseStatus;

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

export class BaseModel
{

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

export class HomepageMenu extends BaseModel
{
    // @Required()
    public HomeText: string;

    // @Required()
    public HomeHidden: boolean;

    // @Required()
    public ServicesText: string;

    // @Required()
    public ServicesHidden: boolean;

    // @Required()
    public BookTimeText: string;

    // @Required()
    public BookTimeHidden: boolean;

    // @Required()
    public AboutUsText: string;

    // @Required()
    public AboutUsHidden: boolean;

    // @Required()
    public ContactUsText: string;

    // @Required()
    public ContactUsHidden: boolean;

    // @Required()
    public MyBookingsText: string;

    // @Required()
    public MyBookingsHidden: boolean;

    // @Required()
    public CalendarText: string;

    // @Required()
    public CalendarHidden: boolean;

    // @Required()
    public NewsText: string;

    // @Required()
    public NewsHidden: boolean;

    // @Required()
    public AddressText: string;

    // @Required()
    public AddressHidden: boolean;

    // @Required()
    public GalleryText: string;

    // @Required()
    public GalleryHidden: boolean;

    public ModifiedDate?: string;
    // @Required()
    public Id: string;

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

export class HomepageMenuQuery extends QueryDb<HomepageMenu, HomepageMenuQueryResponse> implements ICompanyRequest
{
    /** @description Enter the company you want to see news for, if blank and you are an admin, your company id will be used */
    // @ApiMember(Description="Enter the company you want to see news for, if blank and you are an admin, your company id will be used", ParameterType="query")
    public CompanyId?: string;

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

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

export class AccessKeyTypeResponse
{
    public Id: number;
    public KeyType: string;
    public Description: string;

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

// @DataContract
export class QueryResponse<AccessKeyTypeResponse>
{
    // @DataMember(Order=1)
    public Offset: number;

    // @DataMember(Order=2)
    public Total: number;

    // @DataMember(Order=3)
    public Results: AccessKeyTypeResponse[];

    // @DataMember(Order=4)
    public Meta: { [index: string]: string; };

    // @DataMember(Order=5)
    public ResponseStatus: ResponseStatus;

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

TypeScript HomepageMenuQuery 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/menu HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml

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

<QueryResponseOfHomepageMenuQueryResponseWg5EthtI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
    <d2p1:HomepageMenuQueryResponse>
      <d2p1:AboutUsHidden>false</d2p1:AboutUsHidden>
      <d2p1:AboutUsText>String</d2p1:AboutUsText>
      <d2p1:AddressHidden>false</d2p1:AddressHidden>
      <d2p1:AddressText>String</d2p1:AddressText>
      <d2p1:BookTimeHidden>false</d2p1:BookTimeHidden>
      <d2p1:BookTimeText>String</d2p1:BookTimeText>
      <d2p1:CalendarHidden>false</d2p1:CalendarHidden>
      <d2p1:CalendarText>String</d2p1:CalendarText>
      <d2p1:CompanyId>00000000-0000-0000-0000-000000000000</d2p1:CompanyId>
      <d2p1:ContactUsHidden>false</d2p1:ContactUsHidden>
      <d2p1:ContactUsText>String</d2p1:ContactUsText>
      <d2p1:GalleryHidden>false</d2p1:GalleryHidden>
      <d2p1:GalleryText>String</d2p1:GalleryText>
      <d2p1:HomeHidden>false</d2p1:HomeHidden>
      <d2p1:HomeText>String</d2p1:HomeText>
      <d2p1:MyBookingsHidden>false</d2p1:MyBookingsHidden>
      <d2p1:MyBookingsText>String</d2p1:MyBookingsText>
      <d2p1:NewsHidden>false</d2p1:NewsHidden>
      <d2p1:NewsText>String</d2p1:NewsText>
      <d2p1:ResponseStatus>
        <ErrorCode>String</ErrorCode>
        <Message>String</Message>
        <StackTrace>String</StackTrace>
        <Errors>
          <ResponseError>
            <ErrorCode>String</ErrorCode>
            <FieldName>String</FieldName>
            <Message>String</Message>
            <Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </Meta>
          </ResponseError>
        </Errors>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </d2p1:ResponseStatus>
      <d2p1:ServicesHidden>false</d2p1:ServicesHidden>
      <d2p1:ServicesText>String</d2p1:ServicesText>
    </d2p1:HomepageMenuQueryResponse>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfHomepageMenuQueryResponseWg5EthtI>