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 Foundation
import ServiceStack

// @ValidateRequest(Validator="IsAuthenticated")
public class UpdateHomepageMenu : ICompany, Codable
{
    /**
    * 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 var companyId:String?

    /**
    * The text for home menu item
    */
    // @ApiMember(Description="The text for home menu item")
    public var homeText:String

    /**
    * If the home menu item should be hidden
    */
    // @ApiMember(Description="If the home menu item should be hidden")
    public var homeHidden:Bool?

    /**
    * The text for services menu item
    */
    // @ApiMember(Description="The text for services menu item")
    public var servicesText:String

    /**
    * If the services menu item should be hidden
    */
    // @ApiMember(Description="If the services menu item should be hidden")
    public var servicesHidden:Bool?

    /**
    * The text for book time menu item
    */
    // @ApiMember(Description="The text for book time menu item")
    public var bookTimeText:String

    /**
    * If the book time menu item should be hidden
    */
    // @ApiMember(Description="If the book time menu item should be hidden")
    public var bookTimeHidden:Bool?

    /**
    * The text for about us menu item
    */
    // @ApiMember(Description="The text for about us menu item")
    public var aboutUsText:String

    /**
    * If the about us menu item should be hidden
    */
    // @ApiMember(Description="If the about us menu item should be hidden")
    public var aboutUsHidden:Bool?

    /**
    * The text for contact us menu item
    */
    // @ApiMember(Description="The text for contact us menu item")
    public var contactUsText:String

    /**
    * If the contact us menu item should be hidden
    */
    // @ApiMember(Description="If the contact us menu item should be hidden")
    public var contactUsHidden:Bool?

    /**
    * The text for my bookings menu item
    */
    // @ApiMember(Description="The text for my bookings menu item")
    public var myBookingsText:String

    /**
    * If the my bookings menu item should be hidden
    */
    // @ApiMember(Description="If the my bookings menu item should be hidden")
    public var myBookingsHidden:Bool?

    /**
    * The text for calendar menu item
    */
    // @ApiMember(Description="The text for calendar menu item")
    public var calendarText:String

    /**
    * If the calendar menu item should be hidden
    */
    // @ApiMember(Description="If the calendar menu item should be hidden")
    public var calendarHidden:Bool?

    /**
    * The text for news menu item
    */
    // @ApiMember(Description="The text for news menu item")
    public var newsText:String

    /**
    * If the news menu item should be hidden
    */
    // @ApiMember(Description="If the news menu item should be hidden")
    public var newsHidden:Bool?

    /**
    * The text for address menu item
    */
    // @ApiMember(Description="The text for address menu item")
    public var addressText:String

    /**
    * If the address menu item should be hidden
    */
    // @ApiMember(Description="If the address menu item should be hidden")
    public var addressHidden:Bool?

    /**
    * The text for gallery menu item
    */
    // @ApiMember(Description="The text for gallery menu item")
    public var galleryText:String

    /**
    * If the gallery menu item should be hidden
    */
    // @ApiMember(Description="If the gallery menu item should be hidden")
    public var galleryHidden:Bool?

    required public init(){}
}

public class HomepageMenuQueryResponse : Codable
{
    /**
    * The company id
    */
    // @ApiMember(Description="The company id")
    public var companyId:String

    /**
    * The text for home menu item
    */
    // @ApiMember(Description="The text for home menu item")
    public var homeText:String

    /**
    * If the home menu item should be hidden
    */
    // @ApiMember(Description="If the home menu item should be hidden")
    public var homeHidden:Bool

    /**
    * The text for services menu item
    */
    // @ApiMember(Description="The text for services menu item")
    public var servicesText:String

    /**
    * If the services menu item should be hidden
    */
    // @ApiMember(Description="If the services menu item should be hidden")
    public var servicesHidden:Bool

    /**
    * The text for book time menu item
    */
    // @ApiMember(Description="The text for book time menu item")
    public var bookTimeText:String

    /**
    * If the book time menu item should be hidden
    */
    // @ApiMember(Description="If the book time menu item should be hidden")
    public var bookTimeHidden:Bool

    /**
    * The text for about us menu item
    */
    // @ApiMember(Description="The text for about us menu item")
    public var aboutUsText:String

    /**
    * If the about us menu item should be hidden
    */
    // @ApiMember(Description="If the about us menu item should be hidden")
    public var aboutUsHidden:Bool

    /**
    * The text for contact us menu item
    */
    // @ApiMember(Description="The text for contact us menu item")
    public var contactUsText:String

    /**
    * If the contact us menu item should be hidden
    */
    // @ApiMember(Description="If the contact us menu item should be hidden")
    public var contactUsHidden:Bool

    /**
    * The text for my bookings menu item
    */
    // @ApiMember(Description="The text for my bookings menu item")
    public var myBookingsText:String

    /**
    * If the my bookings menu item should be hidden
    */
    // @ApiMember(Description="If the my bookings menu item should be hidden")
    public var myBookingsHidden:Bool

    /**
    * The text for calender menu item
    */
    // @ApiMember(Description="The text for calender menu item")
    public var calendarText:String

    /**
    * If the calendar menu item should be hidden
    */
    // @ApiMember(Description="If the calendar menu item should be hidden")
    public var calendarHidden:Bool

    /**
    * The text for news menu item
    */
    // @ApiMember(Description="The text for news menu item")
    public var newsText:String

    /**
    * If the news menu item should be hidden
    */
    // @ApiMember(Description="If the news menu item should be hidden")
    public var newsHidden:Bool

    /**
    * The text for address menu item
    */
    // @ApiMember(Description="The text for address menu item")
    public var addressText:String

    /**
    * If the address menu item should be hidden
    */
    // @ApiMember(Description="If the address menu item should be hidden")
    public var addressHidden:Bool?

    /**
    * The text for gallery menu item
    */
    // @ApiMember(Description="The text for gallery menu item")
    public var galleryText:String

    /**
    * If the gallery menu item should be hidden
    */
    // @ApiMember(Description="If the gallery menu item should be hidden")
    public var galleryHidden:Bool?

    public var responseStatus:ResponseStatus

    required public init(){}
}


Swift UpdateHomepageMenu DTOs

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

HTTP + 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.bokamera.se 
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>