| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| PUT | /homepage/settings | Update the homepage settings | Update the homepage settings on the company of the currently logged in user, only administrators are allowed to update homepage menu. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | body | Guid? | No | The company id |
| HomepageHeading | body | string | Yes | The text for homepage heading |
| WelcomePageHeading | body | string | Yes | The text for homepage startpage heading |
| WelcomePageBody | body | string | Yes | The text for homepage startpage body |
| AboutUsPageHeading | body | string | Yes | The text for homepage about us page heading |
| AboutUsPageBody | body | string | Yes | The text for homepage about us page body |
| ImageUrl | body | Uri | Yes | The start page image url |
| HomePageTemplateId | body | int? | No | The template for the homepage |
| ShowRating | body | bool? | No | Show rating on the page |
| EnableHomepage | body | bool? | No | Enable the BokaMera Homepage |
| HeroSectionStyleId | body | int? | No | The hero section style for the homepage |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | form | Guid | No | The company id |
| HomepageHeading | form | string | Yes | The text for homepage heading |
| WelcomePageHeading | form | string | Yes | The text for homepage startpage heading |
| WelcomePageBody | form | string | Yes | The text for homepage startpage body |
| AboutUsPageHeading | form | string | Yes | The text for homepage about us page heading |
| AboutUsPageBody | form | string | Yes | The text for homepage about us page body |
| ImageUrl | form | Uri | Yes | The startpage image url |
| HomePageTemplateId | form | int | No | The template for the homepage |
| HeroSectionStyleId | form | int | No | The hero section style for the homepage |
| ShowRating | form | bool | No | Show rating on the page |
| EnableHomepage | form | bool | No | Enable the BokaMera Homepage |
| Updated | form | datetime | No | Will show when the homepage settings was created, note it will only be shown if your logged in as admin for the company. |
| Created | form | datetime | No | Will show when the homepage settings was updated, note it will only be shown if your logged in as admin for the company. |
| HomePageTemplateOptions | query | boolean | Yes | The homepage templates options to select from |
| HomepageHeroSectionStyleOptions | query | boolean | Yes | The homepage hero section style options to select from |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | The template id |
| Name | form | string | Yes | The template name |
| Description | form | string | Yes | The template description |
| ImageUrl | form | Uri | Yes | The template image url |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | The hero section style id |
| Name | form | string | Yes | The hero section style name |
| Description | form | string | Yes | The hero section style description |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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: api.bookmore.com
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>