BokaMera.API.Host

UpdateHomepageMenu

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
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.

"use strict";
export class HomepageMenuQueryResponse {
    /** @param {{CompanyId?:string,HomeText?:string,HomeHidden?:boolean,ServicesText?:string,ServicesHidden?:boolean,BookTimeText?:string,BookTimeHidden?:boolean,AboutUsText?:string,AboutUsHidden?:boolean,ContactUsText?:string,ContactUsHidden?:boolean,MyBookingsText?:string,MyBookingsHidden?:boolean,CalendarText?:string,CalendarHidden?:boolean,NewsText?:string,NewsHidden?:boolean,AddressText?:string,AddressHidden?:boolean,GalleryText?:string,GalleryHidden?:boolean,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The company id */
    CompanyId;
    /**
     * @type {string}
     * @description The text for home menu item */
    HomeText;
    /**
     * @type {boolean}
     * @description If the home menu item should be hidden */
    HomeHidden;
    /**
     * @type {string}
     * @description The text for services menu item */
    ServicesText;
    /**
     * @type {boolean}
     * @description If the services menu item should be hidden */
    ServicesHidden;
    /**
     * @type {string}
     * @description The text for book time menu item */
    BookTimeText;
    /**
     * @type {boolean}
     * @description If the book time menu item should be hidden */
    BookTimeHidden;
    /**
     * @type {string}
     * @description The text for about us menu item */
    AboutUsText;
    /**
     * @type {boolean}
     * @description If the about us menu item should be hidden */
    AboutUsHidden;
    /**
     * @type {string}
     * @description The text for contact us menu item */
    ContactUsText;
    /**
     * @type {boolean}
     * @description If the contact us menu item should be hidden */
    ContactUsHidden;
    /**
     * @type {string}
     * @description The text for my bookings menu item */
    MyBookingsText;
    /**
     * @type {boolean}
     * @description If the my bookings menu item should be hidden */
    MyBookingsHidden;
    /**
     * @type {string}
     * @description The text for calender menu item */
    CalendarText;
    /**
     * @type {boolean}
     * @description If the calendar menu item should be hidden */
    CalendarHidden;
    /**
     * @type {string}
     * @description The text for news menu item */
    NewsText;
    /**
     * @type {boolean}
     * @description If the news menu item should be hidden */
    NewsHidden;
    /**
     * @type {string}
     * @description The text for address menu item */
    AddressText;
    /**
     * @type {?boolean}
     * @description If the address menu item should be hidden */
    AddressHidden;
    /**
     * @type {string}
     * @description The text for gallery menu item */
    GalleryText;
    /**
     * @type {?boolean}
     * @description If the gallery menu item should be hidden */
    GalleryHidden;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class UpdateHomepageMenu {
    /** @param {{CompanyId?:string,HomeText?:string,HomeHidden?:boolean,ServicesText?:string,ServicesHidden?:boolean,BookTimeText?:string,BookTimeHidden?:boolean,AboutUsText?:string,AboutUsHidden?:boolean,ContactUsText?:string,ContactUsHidden?:boolean,MyBookingsText?:string,MyBookingsHidden?:boolean,CalendarText?:string,CalendarHidden?:boolean,NewsText?:string,NewsHidden?:boolean,AddressText?:string,AddressHidden?:boolean,GalleryText?:string,GalleryHidden?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
    /**
     * @type {string}
     * @description The text for home menu item */
    HomeText;
    /**
     * @type {?boolean}
     * @description If the home menu item should be hidden */
    HomeHidden;
    /**
     * @type {string}
     * @description The text for services menu item */
    ServicesText;
    /**
     * @type {?boolean}
     * @description If the services menu item should be hidden */
    ServicesHidden;
    /**
     * @type {string}
     * @description The text for book time menu item */
    BookTimeText;
    /**
     * @type {?boolean}
     * @description If the book time menu item should be hidden */
    BookTimeHidden;
    /**
     * @type {string}
     * @description The text for about us menu item */
    AboutUsText;
    /**
     * @type {?boolean}
     * @description If the about us menu item should be hidden */
    AboutUsHidden;
    /**
     * @type {string}
     * @description The text for contact us menu item */
    ContactUsText;
    /**
     * @type {?boolean}
     * @description If the contact us menu item should be hidden */
    ContactUsHidden;
    /**
     * @type {string}
     * @description The text for my bookings menu item */
    MyBookingsText;
    /**
     * @type {?boolean}
     * @description If the my bookings menu item should be hidden */
    MyBookingsHidden;
    /**
     * @type {string}
     * @description The text for calendar menu item */
    CalendarText;
    /**
     * @type {?boolean}
     * @description If the calendar menu item should be hidden */
    CalendarHidden;
    /**
     * @type {string}
     * @description The text for news menu item */
    NewsText;
    /**
     * @type {?boolean}
     * @description If the news menu item should be hidden */
    NewsHidden;
    /**
     * @type {string}
     * @description The text for address menu item */
    AddressText;
    /**
     * @type {?boolean}
     * @description If the address menu item should be hidden */
    AddressHidden;
    /**
     * @type {string}
     * @description The text for gallery menu item */
    GalleryText;
    /**
     * @type {?boolean}
     * @description If the gallery menu item should be hidden */
    GalleryHidden;
}

JavaScript 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>