| GET | /homepage/settings | Get the homepage settings for the company |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | path | Guid? | No | The company id, if empty will use the company id for the user you are logged in with. |
| IncludeHomePageTemplateOptions | query | boolean | No | If you want to include the homepage template options to select from |
| IncludeHomePageHeroSectionStyleOptions | query | boolean | No | If you want to include the homepage hero section style options to select from |
| SitePath | query | string | Yes | The homepage sitepath. |
| 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 .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /homepage/settings HTTP/1.1 Host: testapi.bokamera.se Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}]}