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

namespace BokaMera.API.ServiceModel.Dtos
{
    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; }
    }

    [ValidateRequest("IsAuthenticated")]
    public partial class UpdateHomepageMenu
        : 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 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 calendar menu item
        ///</summary>
        [ApiMember(Description="The text for calendar 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; }
    }

}

C# 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
		}
	}
}