| 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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateHomepageMenu xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<AboutUsHidden>false</AboutUsHidden>
<AboutUsText>String</AboutUsText>
<AddressHidden>false</AddressHidden>
<AddressText>String</AddressText>
<BookTimeHidden>false</BookTimeHidden>
<BookTimeText>String</BookTimeText>
<CalendarHidden>false</CalendarHidden>
<CalendarText>String</CalendarText>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<ContactUsHidden>false</ContactUsHidden>
<ContactUsText>String</ContactUsText>
<GalleryHidden>false</GalleryHidden>
<GalleryText>String</GalleryText>
<HomeHidden>false</HomeHidden>
<HomeText>String</HomeText>
<MyBookingsHidden>false</MyBookingsHidden>
<MyBookingsText>String</MyBookingsText>
<NewsHidden>false</NewsHidden>
<NewsText>String</NewsText>
<ServicesHidden>false</ServicesHidden>
<ServicesText>String</ServicesText>
</UpdateHomepageMenu>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<HomepageMenuQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<AboutUsHidden>false</AboutUsHidden>
<AboutUsText>String</AboutUsText>
<AddressHidden>false</AddressHidden>
<AddressText>String</AddressText>
<BookTimeHidden>false</BookTimeHidden>
<BookTimeText>String</BookTimeText>
<CalendarHidden>false</CalendarHidden>
<CalendarText>String</CalendarText>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<ContactUsHidden>false</ContactUsHidden>
<ContactUsText>String</ContactUsText>
<GalleryHidden>false</GalleryHidden>
<GalleryText>String</GalleryText>
<HomeHidden>false</HomeHidden>
<HomeText>String</HomeText>
<MyBookingsHidden>false</MyBookingsHidden>
<MyBookingsText>String</MyBookingsText>
<NewsHidden>false</NewsHidden>
<NewsText>String</NewsText>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<ServicesHidden>false</ServicesHidden>
<ServicesText>String</ServicesText>
</HomepageMenuQueryResponse>