| 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. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | body | Guid? | No | The company id, if empty will use the company id for the user you are logged in with. |
| HomeText | body | string | Yes | The text for home menu item |
| HomeHidden | body | bool? | No | If the home menu item should be hidden |
| ServicesText | body | string | Yes | The text for services menu item |
| ServicesHidden | body | bool? | No | If the services menu item should be hidden |
| BookTimeText | body | string | Yes | The text for book time menu item |
| BookTimeHidden | body | bool? | No | If the book time menu item should be hidden |
| AboutUsText | body | string | Yes | The text for about us menu item |
| AboutUsHidden | body | bool? | No | If the about us menu item should be hidden |
| ContactUsText | body | string | Yes | The text for contact us menu item |
| ContactUsHidden | body | bool? | No | If the contact us menu item should be hidden |
| MyBookingsText | body | string | Yes | The text for my bookings menu item |
| MyBookingsHidden | body | bool? | No | If the my bookings menu item should be hidden |
| CalendarText | body | string | Yes | The text for calendar menu item |
| CalendarHidden | body | bool? | No | If the calendar menu item should be hidden |
| NewsText | body | string | Yes | The text for news menu item |
| NewsHidden | body | bool? | No | If the news menu item should be hidden |
| AddressText | body | string | Yes | The text for address menu item |
| AddressHidden | body | bool? | No | If the address menu item should be hidden |
| GalleryText | body | string | Yes | The text for gallery menu item |
| GalleryHidden | body | bool? | No | If the gallery menu item should be hidden |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | form | Guid | No | The company id |
| HomeText | form | string | Yes | The text for home menu item |
| HomeHidden | form | bool | No | If the home menu item should be hidden |
| ServicesText | form | string | Yes | The text for services menu item |
| ServicesHidden | form | bool | No | If the services menu item should be hidden |
| BookTimeText | form | string | Yes | The text for book time menu item |
| BookTimeHidden | form | bool | No | If the book time menu item should be hidden |
| AboutUsText | form | string | Yes | The text for about us menu item |
| AboutUsHidden | form | bool | No | If the about us menu item should be hidden |
| ContactUsText | form | string | Yes | The text for contact us menu item |
| ContactUsHidden | form | bool | No | If the contact us menu item should be hidden |
| MyBookingsText | form | string | Yes | The text for my bookings menu item |
| MyBookingsHidden | form | bool | No | If the my bookings menu item should be hidden |
| CalendarText | form | string | Yes | The text for calender menu item |
| CalendarHidden | form | bool | No | If the calendar menu item should be hidden |
| NewsText | form | string | Yes | The text for news menu item |
| NewsHidden | form | bool | No | If the news menu item should be hidden |
| AddressText | form | string | Yes | The text for address menu item |
| AddressHidden | form | bool? | No | If the address menu item should be hidden |
| GalleryText | form | string | Yes | The text for gallery menu item |
| GalleryHidden | form | bool? | No | If the gallery menu item should be hidden |
| ResponseStatus | form | ResponseStatus | Yes |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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.bookmore.com
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
}
}
}