BokaMera.API.Host

<back to all web services

UpdateHomepageMenu

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/homepage/menuUpdate the homepage menuUpdate 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 net.servicestack.client.*;

public class dtos
{

    @ValidateRequest(Validator="IsAuthenticated")
    public static class UpdateHomepageMenu implements 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.")
        public UUID CompanyId = null;

        /**
        * The text for home menu item
        */
        @ApiMember(Description="The text for home menu item")
        public String HomeText = null;

        /**
        * If the home menu item should be hidden
        */
        @ApiMember(Description="If the home menu item should be hidden")
        public Boolean HomeHidden = null;

        /**
        * The text for services menu item
        */
        @ApiMember(Description="The text for services menu item")
        public String ServicesText = null;

        /**
        * If the services menu item should be hidden
        */
        @ApiMember(Description="If the services menu item should be hidden")
        public Boolean ServicesHidden = null;

        /**
        * The text for book time menu item
        */
        @ApiMember(Description="The text for book time menu item")
        public String BookTimeText = null;

        /**
        * If the book time menu item should be hidden
        */
        @ApiMember(Description="If the book time menu item should be hidden")
        public Boolean BookTimeHidden = null;

        /**
        * The text for about us menu item
        */
        @ApiMember(Description="The text for about us menu item")
        public String AboutUsText = null;

        /**
        * If the about us menu item should be hidden
        */
        @ApiMember(Description="If the about us menu item should be hidden")
        public Boolean AboutUsHidden = null;

        /**
        * The text for contact us menu item
        */
        @ApiMember(Description="The text for contact us menu item")
        public String ContactUsText = null;

        /**
        * If the contact us menu item should be hidden
        */
        @ApiMember(Description="If the contact us menu item should be hidden")
        public Boolean ContactUsHidden = null;

        /**
        * The text for my bookings menu item
        */
        @ApiMember(Description="The text for my bookings menu item")
        public String MyBookingsText = null;

        /**
        * If the my bookings menu item should be hidden
        */
        @ApiMember(Description="If the my bookings menu item should be hidden")
        public Boolean MyBookingsHidden = null;

        /**
        * The text for calendar menu item
        */
        @ApiMember(Description="The text for calendar menu item")
        public String CalendarText = null;

        /**
        * If the calendar menu item should be hidden
        */
        @ApiMember(Description="If the calendar menu item should be hidden")
        public Boolean CalendarHidden = null;

        /**
        * The text for news menu item
        */
        @ApiMember(Description="The text for news menu item")
        public String NewsText = null;

        /**
        * If the news menu item should be hidden
        */
        @ApiMember(Description="If the news menu item should be hidden")
        public Boolean NewsHidden = null;

        /**
        * The text for address menu item
        */
        @ApiMember(Description="The text for address menu item")
        public String AddressText = null;

        /**
        * If the address menu item should be hidden
        */
        @ApiMember(Description="If the address menu item should be hidden")
        public Boolean AddressHidden = null;

        /**
        * The text for gallery menu item
        */
        @ApiMember(Description="The text for gallery menu item")
        public String GalleryText = null;

        /**
        * If the gallery menu item should be hidden
        */
        @ApiMember(Description="If the gallery menu item should be hidden")
        public Boolean GalleryHidden = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public UpdateHomepageMenu setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public String getHomeText() { return HomeText; }
        public UpdateHomepageMenu setHomeText(String value) { this.HomeText = value; return this; }
        public Boolean isHomeHidden() { return HomeHidden; }
        public UpdateHomepageMenu setHomeHidden(Boolean value) { this.HomeHidden = value; return this; }
        public String getServicesText() { return ServicesText; }
        public UpdateHomepageMenu setServicesText(String value) { this.ServicesText = value; return this; }
        public Boolean isServicesHidden() { return ServicesHidden; }
        public UpdateHomepageMenu setServicesHidden(Boolean value) { this.ServicesHidden = value; return this; }
        public String getBookTimeText() { return BookTimeText; }
        public UpdateHomepageMenu setBookTimeText(String value) { this.BookTimeText = value; return this; }
        public Boolean isBookTimeHidden() { return BookTimeHidden; }
        public UpdateHomepageMenu setBookTimeHidden(Boolean value) { this.BookTimeHidden = value; return this; }
        public String getAboutUsText() { return AboutUsText; }
        public UpdateHomepageMenu setAboutUsText(String value) { this.AboutUsText = value; return this; }
        public Boolean isAboutUsHidden() { return AboutUsHidden; }
        public UpdateHomepageMenu setAboutUsHidden(Boolean value) { this.AboutUsHidden = value; return this; }
        public String getContactUsText() { return ContactUsText; }
        public UpdateHomepageMenu setContactUsText(String value) { this.ContactUsText = value; return this; }
        public Boolean isContactUsHidden() { return ContactUsHidden; }
        public UpdateHomepageMenu setContactUsHidden(Boolean value) { this.ContactUsHidden = value; return this; }
        public String getMyBookingsText() { return MyBookingsText; }
        public UpdateHomepageMenu setMyBookingsText(String value) { this.MyBookingsText = value; return this; }
        public Boolean isMyBookingsHidden() { return MyBookingsHidden; }
        public UpdateHomepageMenu setMyBookingsHidden(Boolean value) { this.MyBookingsHidden = value; return this; }
        public String getCalendarText() { return CalendarText; }
        public UpdateHomepageMenu setCalendarText(String value) { this.CalendarText = value; return this; }
        public Boolean isCalendarHidden() { return CalendarHidden; }
        public UpdateHomepageMenu setCalendarHidden(Boolean value) { this.CalendarHidden = value; return this; }
        public String getNewsText() { return NewsText; }
        public UpdateHomepageMenu setNewsText(String value) { this.NewsText = value; return this; }
        public Boolean isNewsHidden() { return NewsHidden; }
        public UpdateHomepageMenu setNewsHidden(Boolean value) { this.NewsHidden = value; return this; }
        public String getAddressText() { return AddressText; }
        public UpdateHomepageMenu setAddressText(String value) { this.AddressText = value; return this; }
        public Boolean isAddressHidden() { return AddressHidden; }
        public UpdateHomepageMenu setAddressHidden(Boolean value) { this.AddressHidden = value; return this; }
        public String getGalleryText() { return GalleryText; }
        public UpdateHomepageMenu setGalleryText(String value) { this.GalleryText = value; return this; }
        public Boolean isGalleryHidden() { return GalleryHidden; }
        public UpdateHomepageMenu setGalleryHidden(Boolean value) { this.GalleryHidden = value; return this; }
    }

    public static class HomepageMenuQueryResponse
    {
        /**
        * The company id
        */
        @ApiMember(Description="The company id")
        public UUID CompanyId = null;

        /**
        * The text for home menu item
        */
        @ApiMember(Description="The text for home menu item")
        public String HomeText = null;

        /**
        * If the home menu item should be hidden
        */
        @ApiMember(Description="If the home menu item should be hidden")
        public Boolean HomeHidden = null;

        /**
        * The text for services menu item
        */
        @ApiMember(Description="The text for services menu item")
        public String ServicesText = null;

        /**
        * If the services menu item should be hidden
        */
        @ApiMember(Description="If the services menu item should be hidden")
        public Boolean ServicesHidden = null;

        /**
        * The text for book time menu item
        */
        @ApiMember(Description="The text for book time menu item")
        public String BookTimeText = null;

        /**
        * If the book time menu item should be hidden
        */
        @ApiMember(Description="If the book time menu item should be hidden")
        public Boolean BookTimeHidden = null;

        /**
        * The text for about us menu item
        */
        @ApiMember(Description="The text for about us menu item")
        public String AboutUsText = null;

        /**
        * If the about us menu item should be hidden
        */
        @ApiMember(Description="If the about us menu item should be hidden")
        public Boolean AboutUsHidden = null;

        /**
        * The text for contact us menu item
        */
        @ApiMember(Description="The text for contact us menu item")
        public String ContactUsText = null;

        /**
        * If the contact us menu item should be hidden
        */
        @ApiMember(Description="If the contact us menu item should be hidden")
        public Boolean ContactUsHidden = null;

        /**
        * The text for my bookings menu item
        */
        @ApiMember(Description="The text for my bookings menu item")
        public String MyBookingsText = null;

        /**
        * If the my bookings menu item should be hidden
        */
        @ApiMember(Description="If the my bookings menu item should be hidden")
        public Boolean MyBookingsHidden = null;

        /**
        * The text for calender menu item
        */
        @ApiMember(Description="The text for calender menu item")
        public String CalendarText = null;

        /**
        * If the calendar menu item should be hidden
        */
        @ApiMember(Description="If the calendar menu item should be hidden")
        public Boolean CalendarHidden = null;

        /**
        * The text for news menu item
        */
        @ApiMember(Description="The text for news menu item")
        public String NewsText = null;

        /**
        * If the news menu item should be hidden
        */
        @ApiMember(Description="If the news menu item should be hidden")
        public Boolean NewsHidden = null;

        /**
        * The text for address menu item
        */
        @ApiMember(Description="The text for address menu item")
        public String AddressText = null;

        /**
        * If the address menu item should be hidden
        */
        @ApiMember(Description="If the address menu item should be hidden")
        public Boolean AddressHidden = null;

        /**
        * The text for gallery menu item
        */
        @ApiMember(Description="The text for gallery menu item")
        public String GalleryText = null;

        /**
        * If the gallery menu item should be hidden
        */
        @ApiMember(Description="If the gallery menu item should be hidden")
        public Boolean GalleryHidden = null;

        public ResponseStatus ResponseStatus = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public HomepageMenuQueryResponse setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public String getHomeText() { return HomeText; }
        public HomepageMenuQueryResponse setHomeText(String value) { this.HomeText = value; return this; }
        public Boolean isHomeHidden() { return HomeHidden; }
        public HomepageMenuQueryResponse setHomeHidden(Boolean value) { this.HomeHidden = value; return this; }
        public String getServicesText() { return ServicesText; }
        public HomepageMenuQueryResponse setServicesText(String value) { this.ServicesText = value; return this; }
        public Boolean isServicesHidden() { return ServicesHidden; }
        public HomepageMenuQueryResponse setServicesHidden(Boolean value) { this.ServicesHidden = value; return this; }
        public String getBookTimeText() { return BookTimeText; }
        public HomepageMenuQueryResponse setBookTimeText(String value) { this.BookTimeText = value; return this; }
        public Boolean isBookTimeHidden() { return BookTimeHidden; }
        public HomepageMenuQueryResponse setBookTimeHidden(Boolean value) { this.BookTimeHidden = value; return this; }
        public String getAboutUsText() { return AboutUsText; }
        public HomepageMenuQueryResponse setAboutUsText(String value) { this.AboutUsText = value; return this; }
        public Boolean isAboutUsHidden() { return AboutUsHidden; }
        public HomepageMenuQueryResponse setAboutUsHidden(Boolean value) { this.AboutUsHidden = value; return this; }
        public String getContactUsText() { return ContactUsText; }
        public HomepageMenuQueryResponse setContactUsText(String value) { this.ContactUsText = value; return this; }
        public Boolean isContactUsHidden() { return ContactUsHidden; }
        public HomepageMenuQueryResponse setContactUsHidden(Boolean value) { this.ContactUsHidden = value; return this; }
        public String getMyBookingsText() { return MyBookingsText; }
        public HomepageMenuQueryResponse setMyBookingsText(String value) { this.MyBookingsText = value; return this; }
        public Boolean isMyBookingsHidden() { return MyBookingsHidden; }
        public HomepageMenuQueryResponse setMyBookingsHidden(Boolean value) { this.MyBookingsHidden = value; return this; }
        public String getCalendarText() { return CalendarText; }
        public HomepageMenuQueryResponse setCalendarText(String value) { this.CalendarText = value; return this; }
        public Boolean isCalendarHidden() { return CalendarHidden; }
        public HomepageMenuQueryResponse setCalendarHidden(Boolean value) { this.CalendarHidden = value; return this; }
        public String getNewsText() { return NewsText; }
        public HomepageMenuQueryResponse setNewsText(String value) { this.NewsText = value; return this; }
        public Boolean isNewsHidden() { return NewsHidden; }
        public HomepageMenuQueryResponse setNewsHidden(Boolean value) { this.NewsHidden = value; return this; }
        public String getAddressText() { return AddressText; }
        public HomepageMenuQueryResponse setAddressText(String value) { this.AddressText = value; return this; }
        public Boolean isAddressHidden() { return AddressHidden; }
        public HomepageMenuQueryResponse setAddressHidden(Boolean value) { this.AddressHidden = value; return this; }
        public String getGalleryText() { return GalleryText; }
        public HomepageMenuQueryResponse setGalleryText(String value) { this.GalleryText = value; return this; }
        public Boolean isGalleryHidden() { return GalleryHidden; }
        public HomepageMenuQueryResponse setGalleryHidden(Boolean value) { this.GalleryHidden = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public HomepageMenuQueryResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java UpdateHomepageMenu DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
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/csv
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"}}}