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
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    public static class HomepageMenuQuery extends QueryDb<HomepageMenu, HomepageMenuQueryResponse> implements 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")
        public UUID CompanyId = null;

        /**
        * The homeage sitepath.
        */
        @ApiMember(Description="The homeage sitepath.")
        public String SitePath = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public HomepageMenuQuery setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public String getSitePath() { return SitePath; }
        public HomepageMenuQuery setSitePath(String value) { this.SitePath = value; return this; }
    }

    public static class QueryDb<From, Into> extends QueryBase
    {
        
    }

    @DataContract
    public static 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)
        public Integer Skip = 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)
        public Integer Take = 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)
        public String OrderBy = 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)
        public String OrderByDesc = 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)
        public String Include = null;

        @DataMember(Order=6)
        public String Fields = null;

        @DataMember(Order=7)
        public HashMap<String,String> Meta = null;
        
        public Integer getSkip() { return Skip; }
        public QueryBase setSkip(Integer value) { this.Skip = value; return this; }
        public Integer getTake() { return Take; }
        public QueryBase setTake(Integer value) { this.Take = value; return this; }
        public String getOrderBy() { return OrderBy; }
        public QueryBase setOrderBy(String value) { this.OrderBy = value; return this; }
        public String getOrderByDesc() { return OrderByDesc; }
        public QueryBase setOrderByDesc(String value) { this.OrderByDesc = value; return this; }
        public String getInclude() { return Include; }
        public QueryBase setInclude(String value) { this.Include = value; return this; }
        public String getFields() { return Fields; }
        public QueryBase setFields(String value) { this.Fields = value; return this; }
        public HashMap<String,String> getMeta() { return Meta; }
        public QueryBase setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
    }

    public static class HomepageMenu extends BaseModel
    {
        @Required()
        public String HomeText = null;

        @Required()
        public Boolean HomeHidden = null;

        @Required()
        public String ServicesText = null;

        @Required()
        public Boolean ServicesHidden = null;

        @Required()
        public String BookTimeText = null;

        @Required()
        public Boolean BookTimeHidden = null;

        @Required()
        public String AboutUsText = null;

        @Required()
        public Boolean AboutUsHidden = null;

        @Required()
        public String ContactUsText = null;

        @Required()
        public Boolean ContactUsHidden = null;

        @Required()
        public String MyBookingsText = null;

        @Required()
        public Boolean MyBookingsHidden = null;

        @Required()
        public String CalendarText = null;

        @Required()
        public Boolean CalendarHidden = null;

        @Required()
        public String NewsText = null;

        @Required()
        public Boolean NewsHidden = null;

        @Required()
        public String AddressText = null;

        @Required()
        public Boolean AddressHidden = null;

        @Required()
        public String GalleryText = null;

        @Required()
        public Boolean GalleryHidden = null;

        public Date ModifiedDate = null;
        @Required()
        public UUID Id = null;
        
        public String getHomeText() { return HomeText; }
        public HomepageMenu setHomeText(String value) { this.HomeText = value; return this; }
        public Boolean isHomeHidden() { return HomeHidden; }
        public HomepageMenu setHomeHidden(Boolean value) { this.HomeHidden = value; return this; }
        public String getServicesText() { return ServicesText; }
        public HomepageMenu setServicesText(String value) { this.ServicesText = value; return this; }
        public Boolean isServicesHidden() { return ServicesHidden; }
        public HomepageMenu setServicesHidden(Boolean value) { this.ServicesHidden = value; return this; }
        public String getBookTimeText() { return BookTimeText; }
        public HomepageMenu setBookTimeText(String value) { this.BookTimeText = value; return this; }
        public Boolean isBookTimeHidden() { return BookTimeHidden; }
        public HomepageMenu setBookTimeHidden(Boolean value) { this.BookTimeHidden = value; return this; }
        public String getAboutUsText() { return AboutUsText; }
        public HomepageMenu setAboutUsText(String value) { this.AboutUsText = value; return this; }
        public Boolean isAboutUsHidden() { return AboutUsHidden; }
        public HomepageMenu setAboutUsHidden(Boolean value) { this.AboutUsHidden = value; return this; }
        public String getContactUsText() { return ContactUsText; }
        public HomepageMenu setContactUsText(String value) { this.ContactUsText = value; return this; }
        public Boolean isContactUsHidden() { return ContactUsHidden; }
        public HomepageMenu setContactUsHidden(Boolean value) { this.ContactUsHidden = value; return this; }
        public String getMyBookingsText() { return MyBookingsText; }
        public HomepageMenu setMyBookingsText(String value) { this.MyBookingsText = value; return this; }
        public Boolean isMyBookingsHidden() { return MyBookingsHidden; }
        public HomepageMenu setMyBookingsHidden(Boolean value) { this.MyBookingsHidden = value; return this; }
        public String getCalendarText() { return CalendarText; }
        public HomepageMenu setCalendarText(String value) { this.CalendarText = value; return this; }
        public Boolean isCalendarHidden() { return CalendarHidden; }
        public HomepageMenu setCalendarHidden(Boolean value) { this.CalendarHidden = value; return this; }
        public String getNewsText() { return NewsText; }
        public HomepageMenu setNewsText(String value) { this.NewsText = value; return this; }
        public Boolean isNewsHidden() { return NewsHidden; }
        public HomepageMenu setNewsHidden(Boolean value) { this.NewsHidden = value; return this; }
        public String getAddressText() { return AddressText; }
        public HomepageMenu setAddressText(String value) { this.AddressText = value; return this; }
        public Boolean isAddressHidden() { return AddressHidden; }
        public HomepageMenu setAddressHidden(Boolean value) { this.AddressHidden = value; return this; }
        public String getGalleryText() { return GalleryText; }
        public HomepageMenu setGalleryText(String value) { this.GalleryText = value; return this; }
        public Boolean isGalleryHidden() { return GalleryHidden; }
        public HomepageMenu setGalleryHidden(Boolean value) { this.GalleryHidden = value; return this; }
        public Date getModifiedDate() { return ModifiedDate; }
        public HomepageMenu setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
        public UUID getId() { return Id; }
        public HomepageMenu setId(UUID value) { this.Id = value; return this; }
    }

    public static class BaseModel
    {
        
    }

    public static class HomepageMenuQueryResponse
    {
        /**
        * The company id
        */
        @ApiMember(Description="The company id")
        public UUID CompanyId = null;

        /**
        * The text for home menu item
        */
        @ApiMember(Description="The text for home menu item")
        public String HomeText = null;

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

        /**
        * The text for services menu item
        */
        @ApiMember(Description="The text for services menu item")
        public String ServicesText = null;

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

        /**
        * The text for book time menu item
        */
        @ApiMember(Description="The text for book time menu item")
        public String BookTimeText = null;

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

        /**
        * The text for about us menu item
        */
        @ApiMember(Description="The text for about us menu item")
        public String AboutUsText = null;

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

        /**
        * The text for contact us menu item
        */
        @ApiMember(Description="The text for contact us menu item")
        public String ContactUsText = null;

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

        /**
        * The text for my bookings menu item
        */
        @ApiMember(Description="The text for my bookings menu item")
        public String MyBookingsText = null;

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

        /**
        * The text for calender menu item
        */
        @ApiMember(Description="The text for calender menu item")
        public String CalendarText = null;

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

        /**
        * The text for news menu item
        */
        @ApiMember(Description="The text for news menu item")
        public String NewsText = null;

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

        /**
        * The text for address menu item
        */
        @ApiMember(Description="The text for address menu item")
        public String AddressText = null;

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

        /**
        * The text for gallery menu item
        */
        @ApiMember(Description="The text for gallery menu item")
        public String GalleryText = null;

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

        public ResponseStatus ResponseStatus = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public HomepageMenuQueryResponse setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public String getHomeText() { return HomeText; }
        public HomepageMenuQueryResponse setHomeText(String value) { this.HomeText = value; return this; }
        public Boolean isHomeHidden() { return HomeHidden; }
        public HomepageMenuQueryResponse setHomeHidden(Boolean value) { this.HomeHidden = value; return this; }
        public String getServicesText() { return ServicesText; }
        public HomepageMenuQueryResponse setServicesText(String value) { this.ServicesText = value; return this; }
        public Boolean isServicesHidden() { return ServicesHidden; }
        public HomepageMenuQueryResponse setServicesHidden(Boolean value) { this.ServicesHidden = value; return this; }
        public String getBookTimeText() { return BookTimeText; }
        public HomepageMenuQueryResponse setBookTimeText(String value) { this.BookTimeText = value; return this; }
        public Boolean isBookTimeHidden() { return BookTimeHidden; }
        public HomepageMenuQueryResponse setBookTimeHidden(Boolean value) { this.BookTimeHidden = value; return this; }
        public String getAboutUsText() { return AboutUsText; }
        public HomepageMenuQueryResponse setAboutUsText(String value) { this.AboutUsText = value; return this; }
        public Boolean isAboutUsHidden() { return AboutUsHidden; }
        public HomepageMenuQueryResponse setAboutUsHidden(Boolean value) { this.AboutUsHidden = value; return this; }
        public String getContactUsText() { return ContactUsText; }
        public HomepageMenuQueryResponse setContactUsText(String value) { this.ContactUsText = value; return this; }
        public Boolean isContactUsHidden() { return ContactUsHidden; }
        public HomepageMenuQueryResponse setContactUsHidden(Boolean value) { this.ContactUsHidden = value; return this; }
        public String getMyBookingsText() { return MyBookingsText; }
        public HomepageMenuQueryResponse setMyBookingsText(String value) { this.MyBookingsText = value; return this; }
        public Boolean isMyBookingsHidden() { return MyBookingsHidden; }
        public HomepageMenuQueryResponse setMyBookingsHidden(Boolean value) { this.MyBookingsHidden = value; return this; }
        public String getCalendarText() { return CalendarText; }
        public HomepageMenuQueryResponse setCalendarText(String value) { this.CalendarText = value; return this; }
        public Boolean isCalendarHidden() { return CalendarHidden; }
        public HomepageMenuQueryResponse setCalendarHidden(Boolean value) { this.CalendarHidden = value; return this; }
        public String getNewsText() { return NewsText; }
        public HomepageMenuQueryResponse setNewsText(String value) { this.NewsText = value; return this; }
        public Boolean isNewsHidden() { return NewsHidden; }
        public HomepageMenuQueryResponse setNewsHidden(Boolean value) { this.NewsHidden = value; return this; }
        public String getAddressText() { return AddressText; }
        public HomepageMenuQueryResponse setAddressText(String value) { this.AddressText = value; return this; }
        public Boolean isAddressHidden() { return AddressHidden; }
        public HomepageMenuQueryResponse setAddressHidden(Boolean value) { this.AddressHidden = value; return this; }
        public String getGalleryText() { return GalleryText; }
        public HomepageMenuQueryResponse setGalleryText(String value) { this.GalleryText = value; return this; }
        public Boolean isGalleryHidden() { return GalleryHidden; }
        public HomepageMenuQueryResponse setGalleryHidden(Boolean value) { this.GalleryHidden = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public HomepageMenuQueryResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    @DataContract
    public static class QueryResponse<AccessKeyTypeResponse>
    {
        @DataMember(Order=1)
        public Integer Offset = null;

        @DataMember(Order=2)
        public Integer Total = null;

        @DataMember(Order=3)
        public ArrayList<AccessKeyTypeResponse> Results = null;

        @DataMember(Order=4)
        public HashMap<String,String> Meta = null;

        @DataMember(Order=5)
        public ResponseStatus ResponseStatus = null;
        
        public Integer getOffset() { return Offset; }
        public QueryResponse<AccessKeyTypeResponse> setOffset(Integer value) { this.Offset = value; return this; }
        public Integer getTotal() { return Total; }
        public QueryResponse<AccessKeyTypeResponse> setTotal(Integer value) { this.Total = value; return this; }
        public ArrayList<AccessKeyTypeResponse> getResults() { return Results; }
        public QueryResponse<AccessKeyTypeResponse> setResults(ArrayList<AccessKeyTypeResponse> value) { this.Results = value; return this; }
        public HashMap<String,String> getMeta() { return Meta; }
        public QueryResponse<AccessKeyTypeResponse> setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public QueryResponse<AccessKeyTypeResponse> setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class AccessKeyTypeResponse
    {
        public Integer Id = null;
        public String KeyType = null;
        public String Description = null;
        
        public Integer getId() { return Id; }
        public AccessKeyTypeResponse setId(Integer value) { this.Id = value; return this; }
        public String getKeyType() { return KeyType; }
        public AccessKeyTypeResponse setKeyType(String value) { this.KeyType = value; return this; }
        public String getDescription() { return Description; }
        public AccessKeyTypeResponse setDescription(String value) { this.Description = value; return this; }
    }

}

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