BokaMera.API.Host

<back to all web services

UpdateHomepageSettings

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/homepage/settingsUpdate the homepage settingsUpdate the homepage settings on the company of the currently logged in user, only administrators are allowed to update homepage menu.
UpdateHomepageSettings Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id
HomepageHeadingbodystringYesThe text for homepage heading
WelcomePageHeadingbodystringYesThe text for homepage startpage heading
WelcomePageBodybodystringYesThe text for homepage startpage body
AboutUsPageHeadingbodystringYesThe text for homepage about us page heading
AboutUsPageBodybodystringYesThe text for homepage about us page body
ImageUrlbodyUriYesThe start page image url
HomePageTemplateIdbodyint?NoThe template for the homepage
ShowRatingbodybool?NoShow rating on the page
EnableHomepagebodybool?NoEnable the BokaMera Homepage
HeroSectionStyleIdbodyint?NoThe hero section style for the homepage
HomepageSettingsQueryResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNoThe company id
HomepageHeadingformstringYesThe text for homepage heading
WelcomePageHeadingformstringYesThe text for homepage startpage heading
WelcomePageBodyformstringYesThe text for homepage startpage body
AboutUsPageHeadingformstringYesThe text for homepage about us page heading
AboutUsPageBodyformstringYesThe text for homepage about us page body
ImageUrlformUriYesThe startpage image url
HomePageTemplateIdformintNoThe template for the homepage
HeroSectionStyleIdformintNoThe hero section style for the homepage
ShowRatingformboolNoShow rating on the page
EnableHomepageformboolNoEnable the BokaMera Homepage
UpdatedformdatetimeNoWill show when the homepage settings was created, note it will only be shown if your logged in as admin for the company.
CreatedformdatetimeNoWill show when the homepage settings was updated, note it will only be shown if your logged in as admin for the company.
HomePageTemplateOptionsquerybooleanYesThe homepage templates options to select from
HomepageHeroSectionStyleOptionsquerybooleanYesThe homepage hero section style options to select from
HomepageTemplateResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe template id
NameformstringYesThe template name
DescriptionformstringYesThe template description
ImageUrlformUriYesThe template image url
HomepageHeroSectionStyleResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe hero section style id
NameformstringYesThe hero section style name
DescriptionformstringYesThe hero section style description

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/settings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateHomepageSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <AboutUsPageBody>String</AboutUsPageBody>
  <AboutUsPageHeading>String</AboutUsPageHeading>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <EnableHomepage>false</EnableHomepage>
  <HeroSectionStyleId>0</HeroSectionStyleId>
  <HomePageTemplateId>0</HomePageTemplateId>
  <HomepageHeading>String</HomepageHeading>
  <ImageUrl i:nil="true" />
  <ShowRating>false</ShowRating>
  <WelcomePageBody>String</WelcomePageBody>
  <WelcomePageHeading>String</WelcomePageHeading>
</UpdateHomepageSettings>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<HomepageSettingsQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <AboutUsPageBody>String</AboutUsPageBody>
  <AboutUsPageHeading>String</AboutUsPageHeading>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Created>0001-01-01T00:00:00</Created>
  <EnableHomepage>false</EnableHomepage>
  <HeroSectionStyleId>0</HeroSectionStyleId>
  <HomePageTemplateId>0</HomePageTemplateId>
  <HomePageTemplateOptions>
    <HomepageTemplateResponse>
      <Description>String</Description>
      <Id>0</Id>
      <ImageUrl i:nil="true" />
      <Name>String</Name>
    </HomepageTemplateResponse>
  </HomePageTemplateOptions>
  <HomepageHeading>String</HomepageHeading>
  <HomepageHeroSectionStyleOptions>
    <HomepageHeroSectionStyleResponse>
      <Description>String</Description>
      <Id>0</Id>
      <Name>String</Name>
    </HomepageHeroSectionStyleResponse>
  </HomepageHeroSectionStyleOptions>
  <ImageUrl i:nil="true" />
  <ShowRating>false</ShowRating>
  <Updated>0001-01-01T00:00:00</Updated>
  <WelcomePageBody>String</WelcomePageBody>
  <WelcomePageHeading>String</WelcomePageHeading>
</HomepageSettingsQueryResponse>