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 java.io.InputStream
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")
    override var CompanyId:UUID? = null

    /**
    * The homepage sitepath.
    */
    @ApiMember(Description="The homepage sitepath.")
    override 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)
    open 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)
    open 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)
    open 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)
    open 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)
    open var Include:String? = null

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

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

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

    @Required()
    open var HomeHidden:Boolean? = null

    @Required()
    open var ServicesText:String? = null

    @Required()
    open var ServicesHidden:Boolean? = null

    @Required()
    open var BookTimeText:String? = null

    @Required()
    open var BookTimeHidden:Boolean? = null

    @Required()
    open var AboutUsText:String? = null

    @Required()
    open var AboutUsHidden:Boolean? = null

    @Required()
    open var ContactUsText:String? = null

    @Required()
    open var ContactUsHidden:Boolean? = null

    @Required()
    open var MyBookingsText:String? = null

    @Required()
    open var MyBookingsHidden:Boolean? = null

    @Required()
    open var CalendarText:String? = null

    @Required()
    open var CalendarHidden:Boolean? = null

    @Required()
    open var NewsText:String? = null

    @Required()
    open var NewsHidden:Boolean? = null

    @Required()
    open var AddressText:String? = null

    @Required()
    open var AddressHidden:Boolean? = null

    @Required()
    open var GalleryText:String? = null

    @Required()
    open var GalleryHidden:Boolean? = null

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

open class BaseModel
{
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    open var ResponseStatus:ResponseStatus? = null
}

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

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

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

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

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

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

Kotlin HomepageMenuQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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.bookmore.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"HomeText":"String","HomeHidden":false,"ServicesText":"String","ServicesHidden":false,"BookTimeText":"String","BookTimeHidden":false,"AboutUsText":"String","AboutUsHidden":false,"ContactUsText":"String","ContactUsHidden":false,"MyBookingsText":"String","MyBookingsHidden":false,"CalendarText":"String","CalendarHidden":false,"NewsText":"String","NewsHidden":false,"AddressText":"String","AddressHidden":false,"GalleryText":"String","GalleryHidden":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}