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
HomepageSettingsQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdpathGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
IncludeHomePageTemplateOptionsquerybooleanNoIf you want to include the homepage template options to select from
IncludeHomePageHeroSectionStyleOptionsquerybooleanNoIf you want to include the homepage hero section style options to select from
SitePathquerystringNoThe homeage sitepath.
HomepageSettingsQueryResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNoThe company id
HomepageHeadingformstringNoThe text for homepage heading
WelcomePageHeadingformstringNoThe text for homepage startpage heading
WelcomePageBodyformstringNoThe text for homepage startpage body
AboutUsPageHeadingformstringNoThe text for homepage about us page heading
AboutUsPageBodyformstringNoThe text for homepage about us page body
ImageUrlformUriNoThe startpage image url
HomePageTemplateIdformintNoThe template for the homepage
HeroSectionStyleIdformintNoThe hero section style for the homepage
ShowRatingformboolNoShow rating on the page
EnableHomepageformboolNoEnable the BokaMera Homepage
UpdatedformdatetimeNoWill show when the homepage settings was created, note it will only be shown if your logged in as admin for the company.
CreatedformdatetimeNoWill show when the homepage settings was updated, note it will only be shown if your logged in as admin for the company.
HomePageTemplateOptionsquerybooleanNoThe homepage templates options to select from
HomepageHeroSectionStyleOptionsquerybooleanNoThe homepage hero section style options to select from
HomepageTemplateResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe template id
NameformstringNoThe template name
DescriptionformstringNoThe template description
ImageUrlformUriNoThe template image url
HomepageHeroSectionStyleResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe hero section style id
NameformstringNoThe hero section style name
DescriptionformstringNoThe hero section style description

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"}]}