BokaMera.API.Host

<back to all web services

UpdateHomepageMenu

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/homepage/menuUpdate the homepage menuUpdate the homepage menu on the company of the currently logged in user, only administrators are allowed to update homepage menu.
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        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

        <ValidateRequest(Validator:="IsAuthenticated")>
        Public Partial Class UpdateHomepageMenu
            Implements ICompany
            '''<Summary>
            '''The company id, if empty will use the company id for the user you are logged in with.
            '''</Summary>
            <ApiMember(Description:="The company id, if empty will use the company id for the user you are logged in with.")>
            Public Overridable Property CompanyId As Nullable(Of 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 Nullable(Of 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 Nullable(Of 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 Nullable(Of 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 Nullable(Of 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 Nullable(Of 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 Nullable(Of Boolean)

            '''<Summary>
            '''The text for calendar menu item
            '''</Summary>
            <ApiMember(Description:="The text for calendar 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 Nullable(Of 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 Nullable(Of 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)
        End Class
    End Namespace
End Namespace

VB.NET UpdateHomepageMenu 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.

PUT /homepage/menu HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	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
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	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
		}
	}
}