| GET | /homepage/settings | Get the homepage settings for the company |
|---|
namespace BokaMera.API.ServiceModel.Dtos
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type HomepageTemplateResponse() =
///<summary>
///The template id
///</summary>
[<ApiMember(Description="The template id")>]
member val Id:Int32 = new Int32() with get,set
///<summary>
///The template name
///</summary>
[<ApiMember(Description="The template name")>]
member val Name:String = null with get,set
///<summary>
///The template description
///</summary>
[<ApiMember(Description="The template description")>]
member val Description:String = null with get,set
///<summary>
///The template image url
///</summary>
[<ApiMember(Description="The template image url")>]
member val ImageUrl:Uri = null with get,set
[<AllowNullLiteral>]
type HomepageHeroSectionStyleResponse() =
///<summary>
///The hero section style id
///</summary>
[<ApiMember(Description="The hero section style id")>]
member val Id:Int32 = new Int32() with get,set
///<summary>
///The hero section style name
///</summary>
[<ApiMember(Description="The hero section style name")>]
member val Name:String = null with get,set
///<summary>
///The hero section style description
///</summary>
[<ApiMember(Description="The hero section style description")>]
member val Description:String = null with get,set
[<AllowNullLiteral>]
type HomepageSettingsQueryResponse() =
///<summary>
///The company id
///</summary>
[<ApiMember(Description="The company id")>]
member val CompanyId:Guid = new Guid() with get,set
///<summary>
///The text for homepage heading
///</summary>
[<ApiMember(Description="The text for homepage heading")>]
member val HomepageHeading:String = null with get,set
///<summary>
///The text for homepage startpage heading
///</summary>
[<ApiMember(Description="The text for homepage startpage heading")>]
member val WelcomePageHeading:String = null with get,set
///<summary>
///The text for homepage startpage body
///</summary>
[<ApiMember(Description="The text for homepage startpage body")>]
member val WelcomePageBody:String = null with get,set
///<summary>
///The text for homepage about us page heading
///</summary>
[<ApiMember(Description="The text for homepage about us page heading")>]
member val AboutUsPageHeading:String = null with get,set
///<summary>
///The text for homepage about us page body
///</summary>
[<ApiMember(Description="The text for homepage about us page body")>]
member val AboutUsPageBody:String = null with get,set
///<summary>
///The startpage image url
///</summary>
[<ApiMember(Description="The startpage image url")>]
member val ImageUrl:Uri = null with get,set
///<summary>
///The template for the homepage
///</summary>
[<ApiMember(Description="The template for the homepage")>]
member val HomePageTemplateId:Int32 = new Int32() with get,set
///<summary>
///The hero section style for the homepage
///</summary>
[<ApiMember(Description="The hero section style for the homepage")>]
member val HeroSectionStyleId:Int32 = new Int32() with get,set
///<summary>
///Show rating on the page
///</summary>
[<ApiMember(Description="Show rating on the page")>]
member val ShowRating:Boolean = new Boolean() with get,set
///<summary>
///Enable the BokaMera Homepage
///</summary>
[<ApiMember(Description="Enable the BokaMera Homepage")>]
member val EnableHomepage:Boolean = new Boolean() with get,set
///<summary>
///Will show when the homepage settings was created, note it will only be shown if your logged in as admin for the company.
///</summary>
[<ApiMember(DataType="datetime", Description="Will show when the homepage settings was created, note it will only be shown if your logged in as admin for the company.")>]
member val Updated:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///Will show when the homepage settings was updated, note it will only be shown if your logged in as admin for the company.
///</summary>
[<ApiMember(DataType="datetime", Description="Will show when the homepage settings was updated, note it will only be shown if your logged in as admin for the company.")>]
member val Created:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///The homepage templates options to select from
///</summary>
[<ApiMember(DataType="boolean", Description="The homepage templates options to select from", ParameterType="query")>]
member val HomePageTemplateOptions:ResizeArray<HomepageTemplateResponse> = new ResizeArray<HomepageTemplateResponse>() with get,set
///<summary>
///The homepage hero section style options to select from
///</summary>
[<ApiMember(DataType="boolean", Description="The homepage hero section style options to select from", ParameterType="query")>]
member val HomepageHeroSectionStyleOptions:ResizeArray<HomepageHeroSectionStyleResponse> = new ResizeArray<HomepageHeroSectionStyleResponse>() with get,set
[<AllowNullLiteral>]
type HomepageSettingsQuery() =
///<summary>
///The company id, if empty will use the company id for the user you are logged in with.
///</summary>
[<ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.", ParameterType="path")>]
member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///If you want to include the homepage template options to select from
///</summary>
[<ApiMember(DataType="boolean", Description="If you want to include the homepage template options to select from", ParameterType="query")>]
member val IncludeHomePageTemplateOptions:Boolean = new Boolean() with get,set
///<summary>
///If you want to include the homepage hero section style options to select from
///</summary>
[<ApiMember(DataType="boolean", Description="If you want to include the homepage hero section style options to select from", ParameterType="query")>]
member val IncludeHomePageHeroSectionStyleOptions:Boolean = new Boolean() with get,set
///<summary>
///The homeage sitepath.
///</summary>
[<ApiMember(Description="The homeage sitepath.")>]
member val SitePath:String = null with get,set
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.
GET /homepage/settings HTTP/1.1 Host: api.bokamera.se Accept: application/xml
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>