BokaMera.API.Host

<back to all web services

UpdateHomepageSettings

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/homepage/settingsUpdate the homepage settingsUpdate the homepage settings on the company of the currently logged in user, only administrators are allowed to update homepage menu.
UpdateHomepageSettings Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id
HomepageHeadingbodystringNoThe text for homepage heading
WelcomePageHeadingbodystringNoThe text for homepage startpage heading
WelcomePageBodybodystringNoThe text for homepage startpage body
AboutUsPageHeadingbodystringNoThe text for homepage about us page heading
AboutUsPageBodybodystringNoThe text for homepage about us page body
ImageUrlbodyUriNoThe startpage image url
HomePageTemplateIdbodyint?NoThe template for the homepage
ShowRatingbodybool?NoShow rating on the page
EnableHomepagebodybool?NoEnable the BokaMera Homepage
HeroSectionStyleIdbodyint?NoThe hero section style for the homepage
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 .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /homepage/settings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","HomepageHeading":"String","WelcomePageHeading":"String","WelcomePageBody":"String","AboutUsPageHeading":"String","AboutUsPageBody":"String","HomePageTemplateId":0,"ShowRating":false,"EnableHomepage":false,"HeroSectionStyleId":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}]}