| GET | /homepage/settings | Get the homepage settings for the company |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
open class HomepageSettingsQuery : ICompany, ICompanyRequest
{
/**
* The company id, if empty will use the company id for the user you are logged in with.
*/
@ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.", ParameterType="path")
override var CompanyId:UUID? = null
/**
* If you want to include the homepage template options to select from
*/
@ApiMember(DataType="boolean", Description="If you want to include the homepage template options to select from", ParameterType="query")
open var IncludeHomePageTemplateOptions:Boolean? = null
/**
* If you want to include the homepage hero section style options to select from
*/
@ApiMember(DataType="boolean", Description="If you want to include the homepage hero section style options to select from", ParameterType="query")
open var IncludeHomePageHeroSectionStyleOptions:Boolean? = null
/**
* The homepage sitepath.
*/
@ApiMember(Description="The homepage sitepath.")
override var SitePath:String? = null
}
open class HomepageSettingsQueryResponse
{
/**
* The company id
*/
@ApiMember(Description="The company id")
open var CompanyId:UUID? = null
/**
* The text for homepage heading
*/
@ApiMember(Description="The text for homepage heading")
open var HomepageHeading:String? = null
/**
* The text for homepage startpage heading
*/
@ApiMember(Description="The text for homepage startpage heading")
open var WelcomePageHeading:String? = null
/**
* The text for homepage startpage body
*/
@ApiMember(Description="The text for homepage startpage body")
open var WelcomePageBody:String? = null
/**
* The text for homepage about us page heading
*/
@ApiMember(Description="The text for homepage about us page heading")
open var AboutUsPageHeading:String? = null
/**
* The text for homepage about us page body
*/
@ApiMember(Description="The text for homepage about us page body")
open var AboutUsPageBody:String? = null
/**
* The startpage image url
*/
@ApiMember(Description="The startpage image url")
open var ImageUrl:Uri? = null
/**
* The template for the homepage
*/
@ApiMember(Description="The template for the homepage")
open var HomePageTemplateId:Int? = null
/**
* The hero section style for the homepage
*/
@ApiMember(Description="The hero section style for the homepage")
open var HeroSectionStyleId:Int? = null
/**
* Show rating on the page
*/
@ApiMember(Description="Show rating on the page")
open var ShowRating:Boolean? = null
/**
* Enable the BokaMera Homepage
*/
@ApiMember(Description="Enable the BokaMera Homepage")
open var EnableHomepage:Boolean? = null
/**
* Will show when the homepage settings was created, note it will only be shown if your logged in as admin for the company.
*/
@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.")
open var Updated:Date? = null
/**
* Will show when the homepage settings was updated, note it will only be shown if your logged in as admin for the company.
*/
@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.")
open var Created:Date? = null
/**
* The homepage templates options to select from
*/
@ApiMember(DataType="boolean", Description="The homepage templates options to select from", ParameterType="query")
open var HomePageTemplateOptions:ArrayList<HomepageTemplateResponse>? = null
/**
* The homepage hero section style options to select from
*/
@ApiMember(DataType="boolean", Description="The homepage hero section style options to select from", ParameterType="query")
open var HomepageHeroSectionStyleOptions:ArrayList<HomepageHeroSectionStyleResponse>? = null
}
open class HomepageTemplateResponse
{
/**
* The template id
*/
@ApiMember(Description="The template id")
open var Id:Int? = null
/**
* The template name
*/
@ApiMember(Description="The template name")
open var Name:String? = null
/**
* The template description
*/
@ApiMember(Description="The template description")
open var Description:String? = null
/**
* The template image url
*/
@ApiMember(Description="The template image url")
open var ImageUrl:Uri? = null
}
open class HomepageHeroSectionStyleResponse
{
/**
* The hero section style id
*/
@ApiMember(Description="The hero section style id")
open var Id:Int? = null
/**
* The hero section style name
*/
@ApiMember(Description="The hero section style name")
open var Name:String? = null
/**
* The hero section style description
*/
@ApiMember(Description="The hero section style description")
open var Description:String? = null
}
Kotlin HomepageSettingsQuery DTOs
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.
GET /homepage/settings HTTP/1.1 Host: api.bookmore.com Accept: text/jsv
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
}
]
}