| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| PUT | /homepage/settings | Update the homepage settings | Update the homepage settings on the company of the currently logged in user, only administrators are allowed to update homepage menu. |
|---|
import Foundation
import ServiceStack
// @ValidateRequest(Validator="IsAuthenticated")
public class UpdateHomepageSettings : ICompany, Codable
{
/**
* The company id
*/
// @ApiMember(Description="The company id")
public var companyId:String?
/**
* The text for homepage heading
*/
// @ApiMember(Description="The text for homepage heading")
public var homepageHeading:String
/**
* The text for homepage startpage heading
*/
// @ApiMember(Description="The text for homepage startpage heading")
public var welcomePageHeading:String
/**
* The text for homepage startpage body
*/
// @ApiMember(Description="The text for homepage startpage body")
public var welcomePageBody:String
/**
* The text for homepage about us page heading
*/
// @ApiMember(Description="The text for homepage about us page heading")
public var aboutUsPageHeading:String
/**
* The text for homepage about us page body
*/
// @ApiMember(Description="The text for homepage about us page body")
public var aboutUsPageBody:String
/**
* The startpage image url
*/
// @ApiMember(Description="The startpage image url")
public var imageUrl:Uri
/**
* The template for the homepage
*/
// @ApiMember(Description="The template for the homepage")
public var homePageTemplateId:Int?
/**
* Show rating on the page
*/
// @ApiMember(Description="Show rating on the page")
public var showRating:Bool?
/**
* Enable the BokaMera Homepage
*/
// @ApiMember(Description="Enable the BokaMera Homepage")
public var enableHomepage:Bool?
/**
* The hero section style for the homepage
*/
// @ApiMember(Description="The hero section style for the homepage")
public var heroSectionStyleId:Int?
required public init(){}
}
public class HomepageSettingsQueryResponse : Codable
{
/**
* The company id
*/
// @ApiMember(Description="The company id")
public var companyId:String
/**
* The text for homepage heading
*/
// @ApiMember(Description="The text for homepage heading")
public var homepageHeading:String
/**
* The text for homepage startpage heading
*/
// @ApiMember(Description="The text for homepage startpage heading")
public var welcomePageHeading:String
/**
* The text for homepage startpage body
*/
// @ApiMember(Description="The text for homepage startpage body")
public var welcomePageBody:String
/**
* The text for homepage about us page heading
*/
// @ApiMember(Description="The text for homepage about us page heading")
public var aboutUsPageHeading:String
/**
* The text for homepage about us page body
*/
// @ApiMember(Description="The text for homepage about us page body")
public var aboutUsPageBody:String
/**
* The startpage image url
*/
// @ApiMember(Description="The startpage image url")
public var imageUrl:Uri
/**
* The template for the homepage
*/
// @ApiMember(Description="The template for the homepage")
public var homePageTemplateId:Int
/**
* The hero section style for the homepage
*/
// @ApiMember(Description="The hero section style for the homepage")
public var heroSectionStyleId:Int
/**
* Show rating on the page
*/
// @ApiMember(Description="Show rating on the page")
public var showRating:Bool
/**
* Enable the BokaMera Homepage
*/
// @ApiMember(Description="Enable the BokaMera Homepage")
public var enableHomepage:Bool
/**
* 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.")
public var updated:Date?
/**
* 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.")
public var created:Date?
/**
* The homepage templates options to select from
*/
// @ApiMember(DataType="boolean", Description="The homepage templates options to select from", ParameterType="query")
public var homePageTemplateOptions:[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")
public var homepageHeroSectionStyleOptions:[HomepageHeroSectionStyleResponse] = []
required public init(){}
}
public class HomepageTemplateResponse : Codable
{
/**
* The template id
*/
// @ApiMember(Description="The template id")
public var id:Int
/**
* The template name
*/
// @ApiMember(Description="The template name")
public var name:String
/**
* The template description
*/
// @ApiMember(Description="The template description")
public var Description:String
/**
* The template image url
*/
// @ApiMember(Description="The template image url")
public var imageUrl:Uri
required public init(){}
}
public class HomepageHeroSectionStyleResponse : Codable
{
/**
* The hero section style id
*/
// @ApiMember(Description="The hero section style id")
public var id:Int
/**
* The hero section style name
*/
// @ApiMember(Description="The hero section style name")
public var name:String
/**
* The hero section style description
*/
// @ApiMember(Description="The hero section style description")
public var Description:String
required public init(){}
}
Swift UpdateHomepageSettings 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.
PUT /homepage/settings HTTP/1.1
Host: testapi.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
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/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
}
]
}