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.

export class HomepageMenuQueryResponse
{
    /** @description The company id */
    // @ApiMember(Description="The company id")
    public CompanyId: string;

    /** @description The text for home menu item */
    // @ApiMember(Description="The text for home menu item")
    public HomeText: string;

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

    /** @description The text for services menu item */
    // @ApiMember(Description="The text for services menu item")
    public ServicesText: string;

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

    /** @description The text for book time menu item */
    // @ApiMember(Description="The text for book time menu item")
    public BookTimeText: string;

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

    /** @description The text for about us menu item */
    // @ApiMember(Description="The text for about us menu item")
    public AboutUsText: string;

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

    /** @description The text for contact us menu item */
    // @ApiMember(Description="The text for contact us menu item")
    public ContactUsText: string;

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

    /** @description The text for my bookings menu item */
    // @ApiMember(Description="The text for my bookings menu item")
    public MyBookingsText: string;

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

    /** @description The text for calender menu item */
    // @ApiMember(Description="The text for calender menu item")
    public CalendarText: string;

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

    /** @description The text for news menu item */
    // @ApiMember(Description="The text for news menu item")
    public NewsText: string;

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

    /** @description The text for address menu item */
    // @ApiMember(Description="The text for address menu item")
    public AddressText: string;

    /** @description If the address menu item should be hidden */
    // @ApiMember(Description="If the address menu item should be hidden")
    public AddressHidden?: boolean;

    /** @description The text for gallery menu item */
    // @ApiMember(Description="The text for gallery menu item")
    public GalleryText: string;

    /** @description If the gallery menu item should be hidden */
    // @ApiMember(Description="If the gallery menu item should be hidden")
    public GalleryHidden?: boolean;

    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<HomepageMenuQueryResponse>) { (Object as any).assign(this, init); }
}

// @ValidateRequest(Validator="IsAuthenticated")
export class UpdateHomepageMenu implements ICompany
{
    /** @description The company id, if empty will use the company id for the user you are logged in with. */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    public CompanyId?: string;

    /** @description The text for home menu item */
    // @ApiMember(Description="The text for home menu item")
    public HomeText: string;

    /** @description If the home menu item should be hidden */
    // @ApiMember(Description="If the home menu item should be hidden")
    public HomeHidden?: boolean;

    /** @description The text for services menu item */
    // @ApiMember(Description="The text for services menu item")
    public ServicesText: string;

    /** @description If the services menu item should be hidden */
    // @ApiMember(Description="If the services menu item should be hidden")
    public ServicesHidden?: boolean;

    /** @description The text for book time menu item */
    // @ApiMember(Description="The text for book time menu item")
    public BookTimeText: string;

    /** @description If the book time menu item should be hidden */
    // @ApiMember(Description="If the book time menu item should be hidden")
    public BookTimeHidden?: boolean;

    /** @description The text for about us menu item */
    // @ApiMember(Description="The text for about us menu item")
    public AboutUsText: string;

    /** @description If the about us menu item should be hidden */
    // @ApiMember(Description="If the about us menu item should be hidden")
    public AboutUsHidden?: boolean;

    /** @description The text for contact us menu item */
    // @ApiMember(Description="The text for contact us menu item")
    public ContactUsText: string;

    /** @description If the contact us menu item should be hidden */
    // @ApiMember(Description="If the contact us menu item should be hidden")
    public ContactUsHidden?: boolean;

    /** @description The text for my bookings menu item */
    // @ApiMember(Description="The text for my bookings menu item")
    public MyBookingsText: string;

    /** @description If the my bookings menu item should be hidden */
    // @ApiMember(Description="If the my bookings menu item should be hidden")
    public MyBookingsHidden?: boolean;

    /** @description The text for calendar menu item */
    // @ApiMember(Description="The text for calendar menu item")
    public CalendarText: string;

    /** @description If the calendar menu item should be hidden */
    // @ApiMember(Description="If the calendar menu item should be hidden")
    public CalendarHidden?: boolean;

    /** @description The text for news menu item */
    // @ApiMember(Description="The text for news menu item")
    public NewsText: string;

    /** @description If the news menu item should be hidden */
    // @ApiMember(Description="If the news menu item should be hidden")
    public NewsHidden?: boolean;

    /** @description The text for address menu item */
    // @ApiMember(Description="The text for address menu item")
    public AddressText: string;

    /** @description If the address menu item should be hidden */
    // @ApiMember(Description="If the address menu item should be hidden")
    public AddressHidden?: boolean;

    /** @description The text for gallery menu item */
    // @ApiMember(Description="The text for gallery menu item")
    public GalleryText: string;

    /** @description If the gallery menu item should be hidden */
    // @ApiMember(Description="If the gallery menu item should be hidden")
    public GalleryHidden?: boolean;

    public constructor(init?: Partial<UpdateHomepageMenu>) { (Object as any).assign(this, init); }
}

TypeScript 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: testapi.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
		}
	}
}