BokaMera.API.Host

HomepageMenuQuery

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

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class HomepageMenuQuery : QueryDb<HomepageMenu, HomepageMenuQueryResponse>(), ICompanyRequest
{
    /**
    * 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")
    var CompanyId:UUID? = null

    /**
    * The homeage sitepath.
    */
    @ApiMember(Description="The homeage sitepath.")
    var SitePath:String? = null
}

open class QueryDb<From, Into> : QueryBase()
{
}

@DataContract
open class QueryBase
{
    /**
    * 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)
    var Skip:Int? = null

    /**
    * 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)
    var Take:Int? = null

    /**
    * 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)
    var OrderBy:String? = null

    /**
    * 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)
    var OrderByDesc:String? = null

    /**
    * 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)
    var Include:String? = null

    @DataMember(Order=6)
    var Fields:String? = null

    @DataMember(Order=7)
    var Meta:HashMap<String,String> = HashMap<String,String>()
}

open class HomepageMenu : BaseModel()
{
    @Required()
    var HomeText:String? = null

    @Required()
    var HomeHidden:Boolean? = null

    @Required()
    var ServicesText:String? = null

    @Required()
    var ServicesHidden:Boolean? = null

    @Required()
    var BookTimeText:String? = null

    @Required()
    var BookTimeHidden:Boolean? = null

    @Required()
    var AboutUsText:String? = null

    @Required()
    var AboutUsHidden:Boolean? = null

    @Required()
    var ContactUsText:String? = null

    @Required()
    var ContactUsHidden:Boolean? = null

    @Required()
    var MyBookingsText:String? = null

    @Required()
    var MyBookingsHidden:Boolean? = null

    @Required()
    var CalendarText:String? = null

    @Required()
    var CalendarHidden:Boolean? = null

    @Required()
    var NewsText:String? = null

    @Required()
    var NewsHidden:Boolean? = null

    @Required()
    var AddressText:String? = null

    @Required()
    var AddressHidden:Boolean? = null

    @Required()
    var GalleryText:String? = null

    @Required()
    var GalleryHidden:Boolean? = null

    var ModifiedDate:Date? = null
    @Required()
    var Id:UUID? = null
}

open class BaseModel
{
}

open class HomepageMenuQueryResponse
{
    /**
    * The company id
    */
    @ApiMember(Description="The company id")
    var CompanyId:UUID? = null

    /**
    * The text for home menu item
    */
    @ApiMember(Description="The text for home menu item")
    var HomeText:String? = null

    /**
    * If the home menu item should be hidden
    */
    @ApiMember(Description="If the home menu item should be hidden")
    var HomeHidden:Boolean? = null

    /**
    * The text for services menu item
    */
    @ApiMember(Description="The text for services menu item")
    var ServicesText:String? = null

    /**
    * If the services menu item should be hidden
    */
    @ApiMember(Description="If the services menu item should be hidden")
    var ServicesHidden:Boolean? = null

    /**
    * The text for book time menu item
    */
    @ApiMember(Description="The text for book time menu item")
    var BookTimeText:String? = null

    /**
    * If the book time menu item should be hidden
    */
    @ApiMember(Description="If the book time menu item should be hidden")
    var BookTimeHidden:Boolean? = null

    /**
    * The text for about us menu item
    */
    @ApiMember(Description="The text for about us menu item")
    var AboutUsText:String? = null

    /**
    * If the about us menu item should be hidden
    */
    @ApiMember(Description="If the about us menu item should be hidden")
    var AboutUsHidden:Boolean? = null

    /**
    * The text for contact us menu item
    */
    @ApiMember(Description="The text for contact us menu item")
    var ContactUsText:String? = null

    /**
    * If the contact us menu item should be hidden
    */
    @ApiMember(Description="If the contact us menu item should be hidden")
    var ContactUsHidden:Boolean? = null

    /**
    * The text for my bookings menu item
    */
    @ApiMember(Description="The text for my bookings menu item")
    var MyBookingsText:String? = null

    /**
    * If the my bookings menu item should be hidden
    */
    @ApiMember(Description="If the my bookings menu item should be hidden")
    var MyBookingsHidden:Boolean? = null

    /**
    * The text for calender menu item
    */
    @ApiMember(Description="The text for calender menu item")
    var CalendarText:String? = null

    /**
    * If the calendar menu item should be hidden
    */
    @ApiMember(Description="If the calendar menu item should be hidden")
    var CalendarHidden:Boolean? = null

    /**
    * The text for news menu item
    */
    @ApiMember(Description="The text for news menu item")
    var NewsText:String? = null

    /**
    * If the news menu item should be hidden
    */
    @ApiMember(Description="If the news menu item should be hidden")
    var NewsHidden:Boolean? = null

    /**
    * The text for address menu item
    */
    @ApiMember(Description="The text for address menu item")
    var AddressText:String? = null

    /**
    * If the address menu item should be hidden
    */
    @ApiMember(Description="If the address menu item should be hidden")
    var AddressHidden:Boolean? = null

    /**
    * The text for gallery menu item
    */
    @ApiMember(Description="The text for gallery menu item")
    var GalleryText:String? = null

    /**
    * If the gallery menu item should be hidden
    */
    @ApiMember(Description="If the gallery menu item should be hidden")
    var GalleryHidden:Boolean? = null

    var ResponseStatus:ResponseStatus? = null
}

@DataContract
open class QueryResponse<AccessKeyTypeResponse>
{
    @DataMember(Order=1)
    var Offset:Int? = null

    @DataMember(Order=2)
    var Total:Int? = null

    @DataMember(Order=3)
    var Results:ArrayList<AccessKeyTypeResponse> = ArrayList<AccessKeyTypeResponse>()

    @DataMember(Order=4)
    var Meta:HashMap<String,String> = HashMap<String,String>()

    @DataMember(Order=5)
    var ResponseStatus:ResponseStatus? = null
}

open class AccessKeyTypeResponse
{
    var Id:Int? = null
    var KeyType:String? = null
    var Description:String? = null
}

Kotlin 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>