Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
PUT | /homepage/menu | Update the homepage menu | Update the homepage menu on the company of the currently logged in user, only administrators are allowed to update homepage menu. |
---|
"use strict";
export class HomepageMenuQueryResponse {
/** @param {{CompanyId?:string,HomeText?:string,HomeHidden?:boolean,ServicesText?:string,ServicesHidden?:boolean,BookTimeText?:string,BookTimeHidden?:boolean,AboutUsText?:string,AboutUsHidden?:boolean,ContactUsText?:string,ContactUsHidden?:boolean,MyBookingsText?:string,MyBookingsHidden?:boolean,CalendarText?:string,CalendarHidden?:boolean,NewsText?:string,NewsHidden?:boolean,AddressText?:string,AddressHidden?:boolean,GalleryText?:string,GalleryHidden?:boolean,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The company id */
CompanyId;
/**
* @type {string}
* @description The text for home menu item */
HomeText;
/**
* @type {boolean}
* @description If the home menu item should be hidden */
HomeHidden;
/**
* @type {string}
* @description The text for services menu item */
ServicesText;
/**
* @type {boolean}
* @description If the services menu item should be hidden */
ServicesHidden;
/**
* @type {string}
* @description The text for book time menu item */
BookTimeText;
/**
* @type {boolean}
* @description If the book time menu item should be hidden */
BookTimeHidden;
/**
* @type {string}
* @description The text for about us menu item */
AboutUsText;
/**
* @type {boolean}
* @description If the about us menu item should be hidden */
AboutUsHidden;
/**
* @type {string}
* @description The text for contact us menu item */
ContactUsText;
/**
* @type {boolean}
* @description If the contact us menu item should be hidden */
ContactUsHidden;
/**
* @type {string}
* @description The text for my bookings menu item */
MyBookingsText;
/**
* @type {boolean}
* @description If the my bookings menu item should be hidden */
MyBookingsHidden;
/**
* @type {string}
* @description The text for calender menu item */
CalendarText;
/**
* @type {boolean}
* @description If the calendar menu item should be hidden */
CalendarHidden;
/**
* @type {string}
* @description The text for news menu item */
NewsText;
/**
* @type {boolean}
* @description If the news menu item should be hidden */
NewsHidden;
/**
* @type {string}
* @description The text for address menu item */
AddressText;
/**
* @type {?boolean}
* @description If the address menu item should be hidden */
AddressHidden;
/**
* @type {string}
* @description The text for gallery menu item */
GalleryText;
/**
* @type {?boolean}
* @description If the gallery menu item should be hidden */
GalleryHidden;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class UpdateHomepageMenu {
/** @param {{CompanyId?:string,HomeText?:string,HomeHidden?:boolean,ServicesText?:string,ServicesHidden?:boolean,BookTimeText?:string,BookTimeHidden?:boolean,AboutUsText?:string,AboutUsHidden?:boolean,ContactUsText?:string,ContactUsHidden?:boolean,MyBookingsText?:string,MyBookingsHidden?:boolean,CalendarText?:string,CalendarHidden?:boolean,NewsText?:string,NewsHidden?:boolean,AddressText?:string,AddressHidden?:boolean,GalleryText?:string,GalleryHidden?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {?string}
* @description The company id, if empty will use the company id for the user you are logged in with. */
CompanyId;
/**
* @type {string}
* @description The text for home menu item */
HomeText;
/**
* @type {?boolean}
* @description If the home menu item should be hidden */
HomeHidden;
/**
* @type {string}
* @description The text for services menu item */
ServicesText;
/**
* @type {?boolean}
* @description If the services menu item should be hidden */
ServicesHidden;
/**
* @type {string}
* @description The text for book time menu item */
BookTimeText;
/**
* @type {?boolean}
* @description If the book time menu item should be hidden */
BookTimeHidden;
/**
* @type {string}
* @description The text for about us menu item */
AboutUsText;
/**
* @type {?boolean}
* @description If the about us menu item should be hidden */
AboutUsHidden;
/**
* @type {string}
* @description The text for contact us menu item */
ContactUsText;
/**
* @type {?boolean}
* @description If the contact us menu item should be hidden */
ContactUsHidden;
/**
* @type {string}
* @description The text for my bookings menu item */
MyBookingsText;
/**
* @type {?boolean}
* @description If the my bookings menu item should be hidden */
MyBookingsHidden;
/**
* @type {string}
* @description The text for calendar menu item */
CalendarText;
/**
* @type {?boolean}
* @description If the calendar menu item should be hidden */
CalendarHidden;
/**
* @type {string}
* @description The text for news menu item */
NewsText;
/**
* @type {?boolean}
* @description If the news menu item should be hidden */
NewsHidden;
/**
* @type {string}
* @description The text for address menu item */
AddressText;
/**
* @type {?boolean}
* @description If the address menu item should be hidden */
AddressHidden;
/**
* @type {string}
* @description The text for gallery menu item */
GalleryText;
/**
* @type {?boolean}
* @description If the gallery menu item should be hidden */
GalleryHidden;
}
JavaScript UpdateHomepageMenu DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
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/jsonl 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"}}}