| 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. |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Namespace Global
Namespace BokaMera.API.ServiceModel.Dtos
Public Partial Class HomepageMenuQueryResponse
'''<Summary>
'''The company id
'''</Summary>
<ApiMember(Description:="The company id")>
Public Overridable Property CompanyId As Guid
'''<Summary>
'''The text for home menu item
'''</Summary>
<ApiMember(Description:="The text for home menu item")>
Public Overridable Property HomeText As String
'''<Summary>
'''If the home menu item should be hidden
'''</Summary>
<ApiMember(Description:="If the home menu item should be hidden")>
Public Overridable Property HomeHidden As Boolean
'''<Summary>
'''The text for services menu item
'''</Summary>
<ApiMember(Description:="The text for services menu item")>
Public Overridable Property ServicesText As String
'''<Summary>
'''If the services menu item should be hidden
'''</Summary>
<ApiMember(Description:="If the services menu item should be hidden")>
Public Overridable Property ServicesHidden As Boolean
'''<Summary>
'''The text for book time menu item
'''</Summary>
<ApiMember(Description:="The text for book time menu item")>
Public Overridable Property BookTimeText As String
'''<Summary>
'''If the book time menu item should be hidden
'''</Summary>
<ApiMember(Description:="If the book time menu item should be hidden")>
Public Overridable Property BookTimeHidden As Boolean
'''<Summary>
'''The text for about us menu item
'''</Summary>
<ApiMember(Description:="The text for about us menu item")>
Public Overridable Property AboutUsText As String
'''<Summary>
'''If the about us menu item should be hidden
'''</Summary>
<ApiMember(Description:="If the about us menu item should be hidden")>
Public Overridable Property AboutUsHidden As Boolean
'''<Summary>
'''The text for contact us menu item
'''</Summary>
<ApiMember(Description:="The text for contact us menu item")>
Public Overridable Property ContactUsText As String
'''<Summary>
'''If the contact us menu item should be hidden
'''</Summary>
<ApiMember(Description:="If the contact us menu item should be hidden")>
Public Overridable Property ContactUsHidden As Boolean
'''<Summary>
'''The text for my bookings menu item
'''</Summary>
<ApiMember(Description:="The text for my bookings menu item")>
Public Overridable Property MyBookingsText As String
'''<Summary>
'''If the my bookings menu item should be hidden
'''</Summary>
<ApiMember(Description:="If the my bookings menu item should be hidden")>
Public Overridable Property MyBookingsHidden As Boolean
'''<Summary>
'''The text for calender menu item
'''</Summary>
<ApiMember(Description:="The text for calender menu item")>
Public Overridable Property CalendarText As String
'''<Summary>
'''If the calendar menu item should be hidden
'''</Summary>
<ApiMember(Description:="If the calendar menu item should be hidden")>
Public Overridable Property CalendarHidden As Boolean
'''<Summary>
'''The text for news menu item
'''</Summary>
<ApiMember(Description:="The text for news menu item")>
Public Overridable Property NewsText As String
'''<Summary>
'''If the news menu item should be hidden
'''</Summary>
<ApiMember(Description:="If the news menu item should be hidden")>
Public Overridable Property NewsHidden As Boolean
'''<Summary>
'''The text for address menu item
'''</Summary>
<ApiMember(Description:="The text for address menu item")>
Public Overridable Property AddressText As String
'''<Summary>
'''If the address menu item should be hidden
'''</Summary>
<ApiMember(Description:="If the address menu item should be hidden")>
Public Overridable Property AddressHidden As Boolean?
'''<Summary>
'''The text for gallery menu item
'''</Summary>
<ApiMember(Description:="The text for gallery menu item")>
Public Overridable Property GalleryText As String
'''<Summary>
'''If the gallery menu item should be hidden
'''</Summary>
<ApiMember(Description:="If the gallery menu item should be hidden")>
Public Overridable Property GalleryHidden As Boolean?
Public Overridable Property ResponseStatus As ResponseStatus
End Class
<ValidateRequest(Validator:="IsAuthenticated")>
Public Partial Class UpdateHomepageMenu
Implements 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 Overridable Property CompanyId As Guid? Implements ICompany.CompanyId
'''<Summary>
'''The text for home menu item
'''</Summary>
<ApiMember(Description:="The text for home menu item")>
Public Overridable Property HomeText As String
'''<Summary>
'''If the home menu item should be hidden
'''</Summary>
<ApiMember(Description:="If the home menu item should be hidden")>
Public Overridable Property HomeHidden As Boolean?
'''<Summary>
'''The text for services menu item
'''</Summary>
<ApiMember(Description:="The text for services menu item")>
Public Overridable Property ServicesText As String
'''<Summary>
'''If the services menu item should be hidden
'''</Summary>
<ApiMember(Description:="If the services menu item should be hidden")>
Public Overridable Property ServicesHidden As Boolean?
'''<Summary>
'''The text for book time menu item
'''</Summary>
<ApiMember(Description:="The text for book time menu item")>
Public Overridable Property BookTimeText As String
'''<Summary>
'''If the book time menu item should be hidden
'''</Summary>
<ApiMember(Description:="If the book time menu item should be hidden")>
Public Overridable Property BookTimeHidden As Boolean?
'''<Summary>
'''The text for about us menu item
'''</Summary>
<ApiMember(Description:="The text for about us menu item")>
Public Overridable Property AboutUsText As String
'''<Summary>
'''If the about us menu item should be hidden
'''</Summary>
<ApiMember(Description:="If the about us menu item should be hidden")>
Public Overridable Property AboutUsHidden As Boolean?
'''<Summary>
'''The text for contact us menu item
'''</Summary>
<ApiMember(Description:="The text for contact us menu item")>
Public Overridable Property ContactUsText As String
'''<Summary>
'''If the contact us menu item should be hidden
'''</Summary>
<ApiMember(Description:="If the contact us menu item should be hidden")>
Public Overridable Property ContactUsHidden As Boolean?
'''<Summary>
'''The text for my bookings menu item
'''</Summary>
<ApiMember(Description:="The text for my bookings menu item")>
Public Overridable Property MyBookingsText As String
'''<Summary>
'''If the my bookings menu item should be hidden
'''</Summary>
<ApiMember(Description:="If the my bookings menu item should be hidden")>
Public Overridable Property MyBookingsHidden As Boolean?
'''<Summary>
'''The text for calendar menu item
'''</Summary>
<ApiMember(Description:="The text for calendar menu item")>
Public Overridable Property CalendarText As String
'''<Summary>
'''If the calendar menu item should be hidden
'''</Summary>
<ApiMember(Description:="If the calendar menu item should be hidden")>
Public Overridable Property CalendarHidden As Boolean?
'''<Summary>
'''The text for news menu item
'''</Summary>
<ApiMember(Description:="The text for news menu item")>
Public Overridable Property NewsText As String
'''<Summary>
'''If the news menu item should be hidden
'''</Summary>
<ApiMember(Description:="If the news menu item should be hidden")>
Public Overridable Property NewsHidden As Boolean?
'''<Summary>
'''The text for address menu item
'''</Summary>
<ApiMember(Description:="The text for address menu item")>
Public Overridable Property AddressText As String
'''<Summary>
'''If the address menu item should be hidden
'''</Summary>
<ApiMember(Description:="If the address menu item should be hidden")>
Public Overridable Property AddressHidden As Boolean?
'''<Summary>
'''The text for gallery menu item
'''</Summary>
<ApiMember(Description:="The text for gallery menu item")>
Public Overridable Property GalleryText As String
'''<Summary>
'''If the gallery menu item should be hidden
'''</Summary>
<ApiMember(Description:="If the gallery menu item should be hidden")>
Public Overridable Property GalleryHidden As Boolean?
End Class
End Namespace
End Namespace
VB.NET UpdateHomepageMenu DTOs
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>