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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.API.ServiceModel.Db;

namespace BokaMera.API.ServiceModel.Db
{
    public partial class BaseModel
    {
    }

    public partial class HomepageMenu
        : BaseModel
    {
        [Required]
        public virtual string HomeText { get; set; }

        [Required]
        public virtual bool HomeHidden { get; set; }

        [Required]
        public virtual string ServicesText { get; set; }

        [Required]
        public virtual bool ServicesHidden { get; set; }

        [Required]
        public virtual string BookTimeText { get; set; }

        [Required]
        public virtual bool BookTimeHidden { get; set; }

        [Required]
        public virtual string AboutUsText { get; set; }

        [Required]
        public virtual bool AboutUsHidden { get; set; }

        [Required]
        public virtual string ContactUsText { get; set; }

        [Required]
        public virtual bool ContactUsHidden { get; set; }

        [Required]
        public virtual string MyBookingsText { get; set; }

        [Required]
        public virtual bool MyBookingsHidden { get; set; }

        [Required]
        public virtual string CalendarText { get; set; }

        [Required]
        public virtual bool CalendarHidden { get; set; }

        [Required]
        public virtual string NewsText { get; set; }

        [Required]
        public virtual bool NewsHidden { get; set; }

        [Required]
        public virtual string AddressText { get; set; }

        [Required]
        public virtual bool AddressHidden { get; set; }

        [Required]
        public virtual string GalleryText { get; set; }

        [Required]
        public virtual bool GalleryHidden { get; set; }

        public virtual DateTimeOffset? ModifiedDate { get; set; }
        [Required]
        public virtual Guid Id { get; set; }
    }

}

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class AccessKeyTypeResponse
    {
        public virtual int Id { get; set; }
        public virtual string KeyType { get; set; }
        public virtual string Description { get; set; }
    }

    public partial class HomepageMenuQuery
        : QueryDb<HomepageMenu, HomepageMenuQueryResponse>, ICompanyRequest
    {
        ///<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")]
        public virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///The homeage sitepath.
        ///</summary>
        [ApiMember(Description="The homeage sitepath.")]
        public virtual string SitePath { get; set; }
    }

    public partial class HomepageMenuQueryResponse
    {
        ///<summary>
        ///The company id
        ///</summary>
        [ApiMember(Description="The company id")]
        public virtual Guid CompanyId { get; set; }

        ///<summary>
        ///The text for home menu item
        ///</summary>
        [ApiMember(Description="The text for home menu item")]
        public virtual string HomeText { get; set; }

        ///<summary>
        ///If the home menu item should be hidden
        ///</summary>
        [ApiMember(Description="If the home menu item should be hidden")]
        public virtual bool HomeHidden { get; set; }

        ///<summary>
        ///The text for services menu item
        ///</summary>
        [ApiMember(Description="The text for services menu item")]
        public virtual string ServicesText { get; set; }

        ///<summary>
        ///If the services menu item should be hidden
        ///</summary>
        [ApiMember(Description="If the services menu item should be hidden")]
        public virtual bool ServicesHidden { get; set; }

        ///<summary>
        ///The text for book time menu item
        ///</summary>
        [ApiMember(Description="The text for book time menu item")]
        public virtual string BookTimeText { get; set; }

        ///<summary>
        ///If the book time menu item should be hidden
        ///</summary>
        [ApiMember(Description="If the book time menu item should be hidden")]
        public virtual bool BookTimeHidden { get; set; }

        ///<summary>
        ///The text for about us menu item
        ///</summary>
        [ApiMember(Description="The text for about us menu item")]
        public virtual string AboutUsText { get; set; }

        ///<summary>
        ///If the about us menu item should be hidden
        ///</summary>
        [ApiMember(Description="If the about us menu item should be hidden")]
        public virtual bool AboutUsHidden { get; set; }

        ///<summary>
        ///The text for contact us menu item
        ///</summary>
        [ApiMember(Description="The text for contact us menu item")]
        public virtual string ContactUsText { get; set; }

        ///<summary>
        ///If the contact us menu item should be hidden
        ///</summary>
        [ApiMember(Description="If the contact us menu item should be hidden")]
        public virtual bool ContactUsHidden { get; set; }

        ///<summary>
        ///The text for my bookings menu item
        ///</summary>
        [ApiMember(Description="The text for my bookings menu item")]
        public virtual string MyBookingsText { get; set; }

        ///<summary>
        ///If the my bookings menu item should be hidden
        ///</summary>
        [ApiMember(Description="If the my bookings menu item should be hidden")]
        public virtual bool MyBookingsHidden { get; set; }

        ///<summary>
        ///The text for calender menu item
        ///</summary>
        [ApiMember(Description="The text for calender menu item")]
        public virtual string CalendarText { get; set; }

        ///<summary>
        ///If the calendar menu item should be hidden
        ///</summary>
        [ApiMember(Description="If the calendar menu item should be hidden")]
        public virtual bool CalendarHidden { get; set; }

        ///<summary>
        ///The text for news menu item
        ///</summary>
        [ApiMember(Description="The text for news menu item")]
        public virtual string NewsText { get; set; }

        ///<summary>
        ///If the news menu item should be hidden
        ///</summary>
        [ApiMember(Description="If the news menu item should be hidden")]
        public virtual bool NewsHidden { get; set; }

        ///<summary>
        ///The text for address menu item
        ///</summary>
        [ApiMember(Description="The text for address menu item")]
        public virtual string AddressText { get; set; }

        ///<summary>
        ///If the address menu item should be hidden
        ///</summary>
        [ApiMember(Description="If the address menu item should be hidden")]
        public virtual bool? AddressHidden { get; set; }

        ///<summary>
        ///The text for gallery menu item
        ///</summary>
        [ApiMember(Description="The text for gallery menu item")]
        public virtual string GalleryText { get; set; }

        ///<summary>
        ///If the gallery menu item should be hidden
        ///</summary>
        [ApiMember(Description="If the gallery menu item should be hidden")]
        public virtual bool? GalleryHidden { get; set; }

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

namespace ServiceStack
{
    [DataContract]
    public partial class QueryBase
    {
        public QueryBase()
        {
            Meta = new Dictionary<string, string>{};
        }

        ///<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)]
        public virtual int? Skip { 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)]
        public virtual int? Take { 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)]
        public virtual string OrderBy { 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)]
        public virtual string OrderByDesc { 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)]
        public virtual string Include { get; set; }

        [DataMember(Order=6)]
        public virtual string Fields { get; set; }

        [DataMember(Order=7)]
        public virtual Dictionary<string, string> Meta { get; set; }
    }

    public partial class QueryDb<From, Into>
        : QueryBase
    {
    }

    [DataContract]
    public partial class QueryResponse<AccessKeyTypeResponse>
    {
        public QueryResponse()
        {
            Results = new List<AccessKeyTypeResponse>{};
            Meta = new Dictionary<string, string>{};
        }

        [DataMember(Order=1)]
        public virtual int Offset { get; set; }

        [DataMember(Order=2)]
        public virtual int Total { get; set; }

        [DataMember(Order=3)]
        public virtual List<AccessKeyTypeResponse> Results { get; set; }

        [DataMember(Order=4)]
        public virtual Dictionary<string, string> Meta { get; set; }

        [DataMember(Order=5)]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# HomepageMenuQuery DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}