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 | No | The text for homepage heading |
WelcomePageHeading | body | string | No | The text for homepage startpage heading |
WelcomePageBody | body | string | No | The text for homepage startpage body |
AboutUsPageHeading | body | string | No | The text for homepage about us page heading |
AboutUsPageBody | body | string | No | The text for homepage about us page body |
ImageUrl | body | Uri | No | 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 | No | The text for homepage heading |
WelcomePageHeading | form | string | No | The text for homepage startpage heading |
WelcomePageBody | form | string | No | The text for homepage startpage body |
AboutUsPageHeading | form | string | No | The text for homepage about us page heading |
AboutUsPageBody | form | string | No | The text for homepage about us page body |
ImageUrl | form | Uri | No | 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 | No | The homepage templates options to select from |
HomepageHeroSectionStyleOptions | query | boolean | No | 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 | No | The template name |
Description | form | string | No | The template description |
ImageUrl | form | Uri | No | The template image url |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | The hero section style id |
Name | form | string | No | The hero section style name |
Description | form | string | No | The hero section style description |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
HomepageHeading: String,
WelcomePageHeading: String,
WelcomePageBody: String,
AboutUsPageHeading: String,
AboutUsPageBody: String,
HomePageTemplateId: 0,
ShowRating: False,
EnableHomepage: False,
HeroSectionStyleId: 0
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { HomepageHeading: String, WelcomePageHeading: String, WelcomePageBody: String, AboutUsPageHeading: String, AboutUsPageBody: String, HomePageTemplateId: 0, HeroSectionStyleId: 0, ShowRating: False, EnableHomepage: False, Updated: "0001-01-01T00:00:00", Created: "0001-01-01T00:00:00", HomePageTemplateOptions: [ { Id: 0, Name: String, Description: String } ], HomepageHeroSectionStyleOptions: [ { Id: 0, Name: String, Description: String } ] }