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

Namespace Global

    Namespace BokaMera.API.ServiceModel.Db

        Public Partial Class BaseModel
        End Class

        Public Partial Class HomepageMenu
            Inherits BaseModel
            <Required>
            Public Overridable Property HomeText As String

            <Required>
            Public Overridable Property HomeHidden As Boolean

            <Required>
            Public Overridable Property ServicesText As String

            <Required>
            Public Overridable Property ServicesHidden As Boolean

            <Required>
            Public Overridable Property BookTimeText As String

            <Required>
            Public Overridable Property BookTimeHidden As Boolean

            <Required>
            Public Overridable Property AboutUsText As String

            <Required>
            Public Overridable Property AboutUsHidden As Boolean

            <Required>
            Public Overridable Property ContactUsText As String

            <Required>
            Public Overridable Property ContactUsHidden As Boolean

            <Required>
            Public Overridable Property MyBookingsText As String

            <Required>
            Public Overridable Property MyBookingsHidden As Boolean

            <Required>
            Public Overridable Property CalendarText As String

            <Required>
            Public Overridable Property CalendarHidden As Boolean

            <Required>
            Public Overridable Property NewsText As String

            <Required>
            Public Overridable Property NewsHidden As Boolean

            <Required>
            Public Overridable Property AddressText As String

            <Required>
            Public Overridable Property AddressHidden As Boolean

            <Required>
            Public Overridable Property GalleryText As String

            <Required>
            Public Overridable Property GalleryHidden As Boolean

            Public Overridable Property ModifiedDate As Nullable(Of DateTimeOffset)
            <Required>
            Public Overridable Property Id As Guid
        End Class
    End Namespace

    Namespace BokaMera.API.ServiceModel.Dtos

        Public Partial Class AccessKeyTypeResponse
            Public Overridable Property Id As Integer
            Public Overridable Property KeyType As String
            Public Overridable Property Description As String
        End Class

        Public Partial Class HomepageMenuQuery
            Inherits QueryDb(Of HomepageMenu, HomepageMenuQueryResponse)
            Implements 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 Overridable Property CompanyId As Nullable(Of Guid)

            '''<Summary>
            '''The homeage sitepath.
            '''</Summary>
            <ApiMember(Description:="The homeage sitepath.")>
            Public Overridable Property SitePath As String
        End Class

        Public Partial Class HomepageMenuQueryResponse
            '''<Summary>
            '''The company id
            '''</Summary>
            <ApiMember(Description:="The company id")>
            Public Overridable Property CompanyId As Guid

            '''<Summary>
            '''The text for home menu item
            '''</Summary>
            <ApiMember(Description:="The text for home menu item")>
            Public Overridable Property HomeText As String

            '''<Summary>
            '''If the home menu item should be hidden
            '''</Summary>
            <ApiMember(Description:="If the home menu item should be hidden")>
            Public Overridable Property HomeHidden As Boolean

            '''<Summary>
            '''The text for services menu item
            '''</Summary>
            <ApiMember(Description:="The text for services menu item")>
            Public Overridable Property ServicesText As String

            '''<Summary>
            '''If the services menu item should be hidden
            '''</Summary>
            <ApiMember(Description:="If the services menu item should be hidden")>
            Public Overridable Property ServicesHidden As Boolean

            '''<Summary>
            '''The text for book time menu item
            '''</Summary>
            <ApiMember(Description:="The text for book time menu item")>
            Public Overridable Property BookTimeText As String

            '''<Summary>
            '''If the book time menu item should be hidden
            '''</Summary>
            <ApiMember(Description:="If the book time menu item should be hidden")>
            Public Overridable Property BookTimeHidden As Boolean

            '''<Summary>
            '''The text for about us menu item
            '''</Summary>
            <ApiMember(Description:="The text for about us menu item")>
            Public Overridable Property AboutUsText As String

            '''<Summary>
            '''If the about us menu item should be hidden
            '''</Summary>
            <ApiMember(Description:="If the about us menu item should be hidden")>
            Public Overridable Property AboutUsHidden As Boolean

            '''<Summary>
            '''The text for contact us menu item
            '''</Summary>
            <ApiMember(Description:="The text for contact us menu item")>
            Public Overridable Property ContactUsText As String

            '''<Summary>
            '''If the contact us menu item should be hidden
            '''</Summary>
            <ApiMember(Description:="If the contact us menu item should be hidden")>
            Public Overridable Property ContactUsHidden As Boolean

            '''<Summary>
            '''The text for my bookings menu item
            '''</Summary>
            <ApiMember(Description:="The text for my bookings menu item")>
            Public Overridable Property MyBookingsText As String

            '''<Summary>
            '''If the my bookings menu item should be hidden
            '''</Summary>
            <ApiMember(Description:="If the my bookings menu item should be hidden")>
            Public Overridable Property MyBookingsHidden As Boolean

            '''<Summary>
            '''The text for calender menu item
            '''</Summary>
            <ApiMember(Description:="The text for calender menu item")>
            Public Overridable Property CalendarText As String

            '''<Summary>
            '''If the calendar menu item should be hidden
            '''</Summary>
            <ApiMember(Description:="If the calendar menu item should be hidden")>
            Public Overridable Property CalendarHidden As Boolean

            '''<Summary>
            '''The text for news menu item
            '''</Summary>
            <ApiMember(Description:="The text for news menu item")>
            Public Overridable Property NewsText As String

            '''<Summary>
            '''If the news menu item should be hidden
            '''</Summary>
            <ApiMember(Description:="If the news menu item should be hidden")>
            Public Overridable Property NewsHidden As Boolean

            '''<Summary>
            '''The text for address menu item
            '''</Summary>
            <ApiMember(Description:="The text for address menu item")>
            Public Overridable Property AddressText As String

            '''<Summary>
            '''If the address menu item should be hidden
            '''</Summary>
            <ApiMember(Description:="If the address menu item should be hidden")>
            Public Overridable Property AddressHidden As Nullable(Of Boolean)

            '''<Summary>
            '''The text for gallery menu item
            '''</Summary>
            <ApiMember(Description:="The text for gallery menu item")>
            Public Overridable Property GalleryText As String

            '''<Summary>
            '''If the gallery menu item should be hidden
            '''</Summary>
            <ApiMember(Description:="If the gallery menu item should be hidden")>
            Public Overridable Property GalleryHidden As Nullable(Of Boolean)

            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace

    Namespace ServiceStack

        <DataContract>
        Public Partial Class QueryBase
            Public Sub New()
                Meta = New Dictionary(Of String, String)
            End Sub

            '''<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 Overridable Property Skip As Nullable(Of Integer)

            '''<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 Overridable Property Take As Nullable(Of Integer)

            '''<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 Overridable Property OrderBy As String

            '''<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 Overridable Property OrderByDesc As String

            '''<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 Overridable Property Include As String

            <DataMember(Order:=6)>
            Public Overridable Property Fields As String

            <DataMember(Order:=7)>
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class

        Public Partial Class QueryDb(Of From, Into)
            Inherits QueryBase
        End Class

        <DataContract>
        Public Partial Class QueryResponse(Of AccessKeyTypeResponse)
            Public Sub New()
                Results = New List(Of AccessKeyTypeResponse)
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property Offset As Integer

            <DataMember(Order:=2)>
            Public Overridable Property Total As Integer

            <DataMember(Order:=3)>
            Public Overridable Property Results As List(Of AccessKeyTypeResponse)

            <DataMember(Order:=4)>
            Public Overridable Property Meta As Dictionary(Of String, String)

            <DataMember(Order:=5)>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET HomepageMenuQuery DTOs

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

HTTP + JSV

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: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}