BokaMera.API.Host

<back to all web services

HomepageSettingsQuery

The following routes are available for this service:
GET/homepage/settingsGet the homepage settings for the company
import java.math.*
import java.util.*
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")
    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")
    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")
    var IncludeHomePageHeroSectionStyleOptions:Boolean? = null

    /**
    * The homeage sitepath.
    */
    @ApiMember(Description="The homeage sitepath.")
    var SitePath:String? = null
}

open class HomepageSettingsQueryResponse
{
    /**
    * The company id
    */
    @ApiMember(Description="The company id")
    var CompanyId:UUID? = null

    /**
    * The text for homepage heading
    */
    @ApiMember(Description="The text for homepage heading")
    var HomepageHeading:String? = null

    /**
    * The text for homepage startpage heading
    */
    @ApiMember(Description="The text for homepage startpage heading")
    var WelcomePageHeading:String? = null

    /**
    * The text for homepage startpage body
    */
    @ApiMember(Description="The text for homepage startpage body")
    var WelcomePageBody:String? = null

    /**
    * The text for homepage about us page heading
    */
    @ApiMember(Description="The text for homepage about us page heading")
    var AboutUsPageHeading:String? = null

    /**
    * The text for homepage about us page body
    */
    @ApiMember(Description="The text for homepage about us page body")
    var AboutUsPageBody:String? = null

    /**
    * The startpage image url
    */
    @ApiMember(Description="The startpage image url")
    var ImageUrl:Uri? = null

    /**
    * The template for the homepage
    */
    @ApiMember(Description="The template for the homepage")
    var HomePageTemplateId:Int? = null

    /**
    * The hero section style for the homepage
    */
    @ApiMember(Description="The hero section style for the homepage")
    var HeroSectionStyleId:Int? = null

    /**
    * Show rating on the page
    */
    @ApiMember(Description="Show rating on the page")
    var ShowRating:Boolean? = null

    /**
    * Enable the BokaMera Homepage
    */
    @ApiMember(Description="Enable the BokaMera Homepage")
    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.")
    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.")
    var Created:Date? = null

    /**
    * The homepage templates options to select from
    */
    @ApiMember(DataType="boolean", Description="The homepage templates options to select from", ParameterType="query")
    var HomePageTemplateOptions:ArrayList<HomepageTemplateResponse> = ArrayList<HomepageTemplateResponse>()

    /**
    * The homepage hero section style options to select from
    */
    @ApiMember(DataType="boolean", Description="The homepage hero section style options to select from", ParameterType="query")
    var HomepageHeroSectionStyleOptions:ArrayList<HomepageHeroSectionStyleResponse> = ArrayList<HomepageHeroSectionStyleResponse>()
}

open class HomepageTemplateResponse
{
    /**
    * The template id
    */
    @ApiMember(Description="The template id")
    var Id:Int? = null

    /**
    * The template name
    */
    @ApiMember(Description="The template name")
    var Name:String? = null

    /**
    * The template description
    */
    @ApiMember(Description="The template description")
    var Description:String? = null

    /**
    * The template image url
    */
    @ApiMember(Description="The template image url")
    var ImageUrl:Uri? = null
}

open class HomepageHeroSectionStyleResponse
{
    /**
    * The hero section style id
    */
    @ApiMember(Description="The hero section style id")
    var Id:Int? = null

    /**
    * The hero section style name
    */
    @ApiMember(Description="The hero section style name")
    var Name:String? = null

    /**
    * The hero section style description
    */
    @ApiMember(Description="The hero section style description")
    var Description:String? = null
}

Kotlin HomepageSettingsQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}]}