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. |
---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
@ValidateRequest(Validator="IsAuthenticated")
open class UpdateHomepageMenu : ICompany
{
/**
* 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.")
override var CompanyId:UUID? = null
/**
* The text for home menu item
*/
@ApiMember(Description="The text for home menu item")
open var HomeText:String? = null
/**
* If the home menu item should be hidden
*/
@ApiMember(Description="If the home menu item should be hidden")
open var HomeHidden:Boolean? = null
/**
* The text for services menu item
*/
@ApiMember(Description="The text for services menu item")
open var ServicesText:String? = null
/**
* If the services menu item should be hidden
*/
@ApiMember(Description="If the services menu item should be hidden")
open var ServicesHidden:Boolean? = null
/**
* The text for book time menu item
*/
@ApiMember(Description="The text for book time menu item")
open var BookTimeText:String? = null
/**
* If the book time menu item should be hidden
*/
@ApiMember(Description="If the book time menu item should be hidden")
open var BookTimeHidden:Boolean? = null
/**
* The text for about us menu item
*/
@ApiMember(Description="The text for about us menu item")
open var AboutUsText:String? = null
/**
* If the about us menu item should be hidden
*/
@ApiMember(Description="If the about us menu item should be hidden")
open var AboutUsHidden:Boolean? = null
/**
* The text for contact us menu item
*/
@ApiMember(Description="The text for contact us menu item")
open var ContactUsText:String? = null
/**
* If the contact us menu item should be hidden
*/
@ApiMember(Description="If the contact us menu item should be hidden")
open var ContactUsHidden:Boolean? = null
/**
* The text for my bookings menu item
*/
@ApiMember(Description="The text for my bookings menu item")
open var MyBookingsText:String? = null
/**
* If the my bookings menu item should be hidden
*/
@ApiMember(Description="If the my bookings menu item should be hidden")
open var MyBookingsHidden:Boolean? = null
/**
* The text for calendar menu item
*/
@ApiMember(Description="The text for calendar menu item")
open var CalendarText:String? = null
/**
* If the calendar menu item should be hidden
*/
@ApiMember(Description="If the calendar menu item should be hidden")
open var CalendarHidden:Boolean? = null
/**
* The text for news menu item
*/
@ApiMember(Description="The text for news menu item")
open var NewsText:String? = null
/**
* If the news menu item should be hidden
*/
@ApiMember(Description="If the news menu item should be hidden")
open var NewsHidden:Boolean? = null
/**
* The text for address menu item
*/
@ApiMember(Description="The text for address menu item")
open var AddressText:String? = null
/**
* If the address menu item should be hidden
*/
@ApiMember(Description="If the address menu item should be hidden")
open var AddressHidden:Boolean? = null
/**
* The text for gallery menu item
*/
@ApiMember(Description="The text for gallery menu item")
open var GalleryText:String? = null
/**
* If the gallery menu item should be hidden
*/
@ApiMember(Description="If the gallery menu item should be hidden")
open var GalleryHidden:Boolean? = null
}
open class HomepageMenuQueryResponse
{
/**
* The company id
*/
@ApiMember(Description="The company id")
open var CompanyId:UUID? = null
/**
* The text for home menu item
*/
@ApiMember(Description="The text for home menu item")
open var HomeText:String? = null
/**
* If the home menu item should be hidden
*/
@ApiMember(Description="If the home menu item should be hidden")
open var HomeHidden:Boolean? = null
/**
* The text for services menu item
*/
@ApiMember(Description="The text for services menu item")
open var ServicesText:String? = null
/**
* If the services menu item should be hidden
*/
@ApiMember(Description="If the services menu item should be hidden")
open var ServicesHidden:Boolean? = null
/**
* The text for book time menu item
*/
@ApiMember(Description="The text for book time menu item")
open var BookTimeText:String? = null
/**
* If the book time menu item should be hidden
*/
@ApiMember(Description="If the book time menu item should be hidden")
open var BookTimeHidden:Boolean? = null
/**
* The text for about us menu item
*/
@ApiMember(Description="The text for about us menu item")
open var AboutUsText:String? = null
/**
* If the about us menu item should be hidden
*/
@ApiMember(Description="If the about us menu item should be hidden")
open var AboutUsHidden:Boolean? = null
/**
* The text for contact us menu item
*/
@ApiMember(Description="The text for contact us menu item")
open var ContactUsText:String? = null
/**
* If the contact us menu item should be hidden
*/
@ApiMember(Description="If the contact us menu item should be hidden")
open var ContactUsHidden:Boolean? = null
/**
* The text for my bookings menu item
*/
@ApiMember(Description="The text for my bookings menu item")
open var MyBookingsText:String? = null
/**
* If the my bookings menu item should be hidden
*/
@ApiMember(Description="If the my bookings menu item should be hidden")
open var MyBookingsHidden:Boolean? = null
/**
* The text for calender menu item
*/
@ApiMember(Description="The text for calender menu item")
open var CalendarText:String? = null
/**
* If the calendar menu item should be hidden
*/
@ApiMember(Description="If the calendar menu item should be hidden")
open var CalendarHidden:Boolean? = null
/**
* The text for news menu item
*/
@ApiMember(Description="The text for news menu item")
open var NewsText:String? = null
/**
* If the news menu item should be hidden
*/
@ApiMember(Description="If the news menu item should be hidden")
open var NewsHidden:Boolean? = null
/**
* The text for address menu item
*/
@ApiMember(Description="The text for address menu item")
open var AddressText:String? = null
/**
* If the address menu item should be hidden
*/
@ApiMember(Description="If the address menu item should be hidden")
open var AddressHidden:Boolean? = null
/**
* The text for gallery menu item
*/
@ApiMember(Description="The text for gallery menu item")
open var GalleryText:String? = null
/**
* If the gallery menu item should be hidden
*/
@ApiMember(Description="If the gallery menu item should be hidden")
open var GalleryHidden:Boolean? = null
open var ResponseStatus:ResponseStatus? = null
}
Kotlin 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.bookmore.com
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"}}}