BokaMera.API.Host

HomepageMenuQuery

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

namespace BokaMera.API.ServiceModel.Db

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type HomepageMenuQueryResponse() = 
        ///<summary>
        ///The company id
        ///</summary>
        [<ApiMember(Description="The company id")>]
        member val CompanyId:Guid = new Guid() with get,set

        ///<summary>
        ///The text for home menu item
        ///</summary>
        [<ApiMember(Description="The text for home menu item")>]
        member val HomeText:String = null with get,set

        ///<summary>
        ///If the home menu item should be hidden
        ///</summary>
        [<ApiMember(Description="If the home menu item should be hidden")>]
        member val HomeHidden:Boolean = new Boolean() with get,set

        ///<summary>
        ///The text for services menu item
        ///</summary>
        [<ApiMember(Description="The text for services menu item")>]
        member val ServicesText:String = null with get,set

        ///<summary>
        ///If the services menu item should be hidden
        ///</summary>
        [<ApiMember(Description="If the services menu item should be hidden")>]
        member val ServicesHidden:Boolean = new Boolean() with get,set

        ///<summary>
        ///The text for book time menu item
        ///</summary>
        [<ApiMember(Description="The text for book time menu item")>]
        member val BookTimeText:String = null with get,set

        ///<summary>
        ///If the book time menu item should be hidden
        ///</summary>
        [<ApiMember(Description="If the book time menu item should be hidden")>]
        member val BookTimeHidden:Boolean = new Boolean() with get,set

        ///<summary>
        ///The text for about us menu item
        ///</summary>
        [<ApiMember(Description="The text for about us menu item")>]
        member val AboutUsText:String = null with get,set

        ///<summary>
        ///If the about us menu item should be hidden
        ///</summary>
        [<ApiMember(Description="If the about us menu item should be hidden")>]
        member val AboutUsHidden:Boolean = new Boolean() with get,set

        ///<summary>
        ///The text for contact us menu item
        ///</summary>
        [<ApiMember(Description="The text for contact us menu item")>]
        member val ContactUsText:String = null with get,set

        ///<summary>
        ///If the contact us menu item should be hidden
        ///</summary>
        [<ApiMember(Description="If the contact us menu item should be hidden")>]
        member val ContactUsHidden:Boolean = new Boolean() with get,set

        ///<summary>
        ///The text for my bookings menu item
        ///</summary>
        [<ApiMember(Description="The text for my bookings menu item")>]
        member val MyBookingsText:String = null with get,set

        ///<summary>
        ///If the my bookings menu item should be hidden
        ///</summary>
        [<ApiMember(Description="If the my bookings menu item should be hidden")>]
        member val MyBookingsHidden:Boolean = new Boolean() with get,set

        ///<summary>
        ///The text for calender menu item
        ///</summary>
        [<ApiMember(Description="The text for calender menu item")>]
        member val CalendarText:String = null with get,set

        ///<summary>
        ///If the calendar menu item should be hidden
        ///</summary>
        [<ApiMember(Description="If the calendar menu item should be hidden")>]
        member val CalendarHidden:Boolean = new Boolean() with get,set

        ///<summary>
        ///The text for news menu item
        ///</summary>
        [<ApiMember(Description="The text for news menu item")>]
        member val NewsText:String = null with get,set

        ///<summary>
        ///If the news menu item should be hidden
        ///</summary>
        [<ApiMember(Description="If the news menu item should be hidden")>]
        member val NewsHidden:Boolean = new Boolean() with get,set

        ///<summary>
        ///The text for address menu item
        ///</summary>
        [<ApiMember(Description="The text for address menu item")>]
        member val AddressText:String = null with get,set

        ///<summary>
        ///If the address menu item should be hidden
        ///</summary>
        [<ApiMember(Description="If the address menu item should be hidden")>]
        member val AddressHidden:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        ///<summary>
        ///The text for gallery menu item
        ///</summary>
        [<ApiMember(Description="The text for gallery menu item")>]
        member val GalleryText:String = null with get,set

        ///<summary>
        ///If the gallery menu item should be hidden
        ///</summary>
        [<ApiMember(Description="If the gallery menu item should be hidden")>]
        member val GalleryHidden:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type BaseModel() = 
        class end

    [<AllowNullLiteral>]
    type HomepageMenu() = 
        inherit BaseModel()
        [<Required>]
        member val HomeText:String = null with get,set

        [<Required>]
        member val HomeHidden:Boolean = new Boolean() with get,set

        [<Required>]
        member val ServicesText:String = null with get,set

        [<Required>]
        member val ServicesHidden:Boolean = new Boolean() with get,set

        [<Required>]
        member val BookTimeText:String = null with get,set

        [<Required>]
        member val BookTimeHidden:Boolean = new Boolean() with get,set

        [<Required>]
        member val AboutUsText:String = null with get,set

        [<Required>]
        member val AboutUsHidden:Boolean = new Boolean() with get,set

        [<Required>]
        member val ContactUsText:String = null with get,set

        [<Required>]
        member val ContactUsHidden:Boolean = new Boolean() with get,set

        [<Required>]
        member val MyBookingsText:String = null with get,set

        [<Required>]
        member val MyBookingsHidden:Boolean = new Boolean() with get,set

        [<Required>]
        member val CalendarText:String = null with get,set

        [<Required>]
        member val CalendarHidden:Boolean = new Boolean() with get,set

        [<Required>]
        member val NewsText:String = null with get,set

        [<Required>]
        member val NewsHidden:Boolean = new Boolean() with get,set

        [<Required>]
        member val AddressText:String = null with get,set

        [<Required>]
        member val AddressHidden:Boolean = new Boolean() with get,set

        [<Required>]
        member val GalleryText:String = null with get,set

        [<Required>]
        member val GalleryHidden:Boolean = new Boolean() with get,set

        member val ModifiedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
        [<Required>]
        member val Id:Guid = new Guid() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryBase() = 
        ///<summary>
        ///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>
        ///</summary>
        [<DataMember(Order=1)>]
        member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///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>
        ///</summary>
        [<DataMember(Order=2)>]
        member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///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>
        ///</summary>
        [<DataMember(Order=3)>]
        member val OrderBy:String = null with get,set

        ///<summary>
        ///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>
        ///</summary>
        [<DataMember(Order=4)>]
        member val OrderByDesc:String = null with get,set

        ///<summary>
        ///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>
        ///</summary>
        [<DataMember(Order=5)>]
        member val Include:String = null with get,set

        [<DataMember(Order=6)>]
        member val Fields:String = null with get,set

        [<DataMember(Order=7)>]
        member val Meta:Dictionary<String, String> = null with get,set

    [<AllowNullLiteral>]
    type QueryDb<From, Into>() = 
        inherit QueryBase()

    [<AllowNullLiteral>]
    type HomepageMenuQuery() = 
        inherit QueryDb<HomepageMenu, HomepageMenuQueryResponse>()
        ///<summary>
        ///Enter the company you want to see news for, if blank and you are an admin, your company id will be used
        ///</summary>
        [<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")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///The homepage sitepath.
        ///</summary>
        [<ApiMember(Description="The homepage sitepath.")>]
        member val SitePath:String = null with get,set

    [<AllowNullLiteral>]
    type AccessKeyTypeResponse() = 
        member val Id:Int32 = new Int32() with get,set
        member val KeyType:String = null with get,set
        member val Description:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryResponse<T>() = 
        [<DataMember(Order=1)>]
        member val Offset:Int32 = new Int32() with get,set

        [<DataMember(Order=2)>]
        member val Total:Int32 = new Int32() with get,set

        [<DataMember(Order=3)>]
        member val Results:ResizeArray<AccessKeyTypeResponse> = null with get,set

        [<DataMember(Order=4)>]
        member val Meta:Dictionary<String, String> = null with get,set

        [<DataMember(Order=5)>]
        member val ResponseStatus:ResponseStatus = null with get,set

F# 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: testapi.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>