| 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 java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
@ValidateRequest(Validator="IsAuthenticated")
public static class UpdateHomepageSettings implements ICompany
{
/**
* The company id
*/
@ApiMember(Description="The company id")
public UUID CompanyId = null;
/**
* The text for homepage heading
*/
@ApiMember(Description="The text for homepage heading")
public String HomepageHeading = null;
/**
* The text for homepage startpage heading
*/
@ApiMember(Description="The text for homepage startpage heading")
public String WelcomePageHeading = null;
/**
* The text for homepage startpage body
*/
@ApiMember(Description="The text for homepage startpage body")
public String WelcomePageBody = null;
/**
* The text for homepage about us page heading
*/
@ApiMember(Description="The text for homepage about us page heading")
public String AboutUsPageHeading = null;
/**
* The text for homepage about us page body
*/
@ApiMember(Description="The text for homepage about us page body")
public String AboutUsPageBody = null;
/**
* The startpage image url
*/
@ApiMember(Description="The startpage image url")
public Uri ImageUrl = null;
/**
* The template for the homepage
*/
@ApiMember(Description="The template for the homepage")
public Integer HomePageTemplateId = null;
/**
* Show rating on the page
*/
@ApiMember(Description="Show rating on the page")
public Boolean ShowRating = null;
/**
* Enable the BokaMera Homepage
*/
@ApiMember(Description="Enable the BokaMera Homepage")
public Boolean EnableHomepage = null;
/**
* The hero section style for the homepage
*/
@ApiMember(Description="The hero section style for the homepage")
public Integer HeroSectionStyleId = null;
public UUID getCompanyId() { return CompanyId; }
public UpdateHomepageSettings setCompanyId(UUID value) { this.CompanyId = value; return this; }
public String getHomepageHeading() { return HomepageHeading; }
public UpdateHomepageSettings setHomepageHeading(String value) { this.HomepageHeading = value; return this; }
public String getWelcomePageHeading() { return WelcomePageHeading; }
public UpdateHomepageSettings setWelcomePageHeading(String value) { this.WelcomePageHeading = value; return this; }
public String getWelcomePageBody() { return WelcomePageBody; }
public UpdateHomepageSettings setWelcomePageBody(String value) { this.WelcomePageBody = value; return this; }
public String getAboutUsPageHeading() { return AboutUsPageHeading; }
public UpdateHomepageSettings setAboutUsPageHeading(String value) { this.AboutUsPageHeading = value; return this; }
public String getAboutUsPageBody() { return AboutUsPageBody; }
public UpdateHomepageSettings setAboutUsPageBody(String value) { this.AboutUsPageBody = value; return this; }
public Uri getImageUrl() { return ImageUrl; }
public UpdateHomepageSettings setImageUrl(Uri value) { this.ImageUrl = value; return this; }
public Integer getHomePageTemplateId() { return HomePageTemplateId; }
public UpdateHomepageSettings setHomePageTemplateId(Integer value) { this.HomePageTemplateId = value; return this; }
public Boolean isShowRating() { return ShowRating; }
public UpdateHomepageSettings setShowRating(Boolean value) { this.ShowRating = value; return this; }
public Boolean isEnableHomepage() { return EnableHomepage; }
public UpdateHomepageSettings setEnableHomepage(Boolean value) { this.EnableHomepage = value; return this; }
public Integer getHeroSectionStyleId() { return HeroSectionStyleId; }
public UpdateHomepageSettings setHeroSectionStyleId(Integer value) { this.HeroSectionStyleId = value; return this; }
}
public static class HomepageSettingsQueryResponse
{
/**
* The company id
*/
@ApiMember(Description="The company id")
public UUID CompanyId = null;
/**
* The text for homepage heading
*/
@ApiMember(Description="The text for homepage heading")
public String HomepageHeading = null;
/**
* The text for homepage startpage heading
*/
@ApiMember(Description="The text for homepage startpage heading")
public String WelcomePageHeading = null;
/**
* The text for homepage startpage body
*/
@ApiMember(Description="The text for homepage startpage body")
public String WelcomePageBody = null;
/**
* The text for homepage about us page heading
*/
@ApiMember(Description="The text for homepage about us page heading")
public String AboutUsPageHeading = null;
/**
* The text for homepage about us page body
*/
@ApiMember(Description="The text for homepage about us page body")
public String AboutUsPageBody = null;
/**
* The startpage image url
*/
@ApiMember(Description="The startpage image url")
public Uri ImageUrl = null;
/**
* The template for the homepage
*/
@ApiMember(Description="The template for the homepage")
public Integer HomePageTemplateId = null;
/**
* The hero section style for the homepage
*/
@ApiMember(Description="The hero section style for the homepage")
public Integer HeroSectionStyleId = null;
/**
* Show rating on the page
*/
@ApiMember(Description="Show rating on the page")
public Boolean ShowRating = null;
/**
* Enable the BokaMera Homepage
*/
@ApiMember(Description="Enable the BokaMera Homepage")
public Boolean EnableHomepage = 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.")
public Date Updated = 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.")
public Date Created = null;
/**
* The homepage templates options to select from
*/
@ApiMember(DataType="boolean", Description="The homepage templates options to select from", ParameterType="query")
public ArrayList<HomepageTemplateResponse> HomePageTemplateOptions = 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")
public ArrayList<HomepageHeroSectionStyleResponse> HomepageHeroSectionStyleOptions = null;
public UUID getCompanyId() { return CompanyId; }
public HomepageSettingsQueryResponse setCompanyId(UUID value) { this.CompanyId = value; return this; }
public String getHomepageHeading() { return HomepageHeading; }
public HomepageSettingsQueryResponse setHomepageHeading(String value) { this.HomepageHeading = value; return this; }
public String getWelcomePageHeading() { return WelcomePageHeading; }
public HomepageSettingsQueryResponse setWelcomePageHeading(String value) { this.WelcomePageHeading = value; return this; }
public String getWelcomePageBody() { return WelcomePageBody; }
public HomepageSettingsQueryResponse setWelcomePageBody(String value) { this.WelcomePageBody = value; return this; }
public String getAboutUsPageHeading() { return AboutUsPageHeading; }
public HomepageSettingsQueryResponse setAboutUsPageHeading(String value) { this.AboutUsPageHeading = value; return this; }
public String getAboutUsPageBody() { return AboutUsPageBody; }
public HomepageSettingsQueryResponse setAboutUsPageBody(String value) { this.AboutUsPageBody = value; return this; }
public Uri getImageUrl() { return ImageUrl; }
public HomepageSettingsQueryResponse setImageUrl(Uri value) { this.ImageUrl = value; return this; }
public Integer getHomePageTemplateId() { return HomePageTemplateId; }
public HomepageSettingsQueryResponse setHomePageTemplateId(Integer value) { this.HomePageTemplateId = value; return this; }
public Integer getHeroSectionStyleId() { return HeroSectionStyleId; }
public HomepageSettingsQueryResponse setHeroSectionStyleId(Integer value) { this.HeroSectionStyleId = value; return this; }
public Boolean isShowRating() { return ShowRating; }
public HomepageSettingsQueryResponse setShowRating(Boolean value) { this.ShowRating = value; return this; }
public Boolean isEnableHomepage() { return EnableHomepage; }
public HomepageSettingsQueryResponse setEnableHomepage(Boolean value) { this.EnableHomepage = value; return this; }
public Date getUpdated() { return Updated; }
public HomepageSettingsQueryResponse setUpdated(Date value) { this.Updated = value; return this; }
public Date getCreated() { return Created; }
public HomepageSettingsQueryResponse setCreated(Date value) { this.Created = value; return this; }
public ArrayList<HomepageTemplateResponse> getHomePageTemplateOptions() { return HomePageTemplateOptions; }
public HomepageSettingsQueryResponse setHomePageTemplateOptions(ArrayList<HomepageTemplateResponse> value) { this.HomePageTemplateOptions = value; return this; }
public ArrayList<HomepageHeroSectionStyleResponse> getHomepageHeroSectionStyleOptions() { return HomepageHeroSectionStyleOptions; }
public HomepageSettingsQueryResponse setHomepageHeroSectionStyleOptions(ArrayList<HomepageHeroSectionStyleResponse> value) { this.HomepageHeroSectionStyleOptions = value; return this; }
}
public static class HomepageTemplateResponse
{
/**
* The template id
*/
@ApiMember(Description="The template id")
public Integer Id = null;
/**
* The template name
*/
@ApiMember(Description="The template name")
public String Name = null;
/**
* The template description
*/
@ApiMember(Description="The template description")
public String Description = null;
/**
* The template image url
*/
@ApiMember(Description="The template image url")
public Uri ImageUrl = null;
public Integer getId() { return Id; }
public HomepageTemplateResponse setId(Integer value) { this.Id = value; return this; }
public String getName() { return Name; }
public HomepageTemplateResponse setName(String value) { this.Name = value; return this; }
public String getDescription() { return Description; }
public HomepageTemplateResponse setDescription(String value) { this.Description = value; return this; }
public Uri getImageUrl() { return ImageUrl; }
public HomepageTemplateResponse setImageUrl(Uri value) { this.ImageUrl = value; return this; }
}
public static class HomepageHeroSectionStyleResponse
{
/**
* The hero section style id
*/
@ApiMember(Description="The hero section style id")
public Integer Id = null;
/**
* The hero section style name
*/
@ApiMember(Description="The hero section style name")
public String Name = null;
/**
* The hero section style description
*/
@ApiMember(Description="The hero section style description")
public String Description = null;
public Integer getId() { return Id; }
public HomepageHeroSectionStyleResponse setId(Integer value) { this.Id = value; return this; }
public String getName() { return Name; }
public HomepageHeroSectionStyleResponse setName(String value) { this.Name = value; return this; }
public String getDescription() { return Description; }
public HomepageHeroSectionStyleResponse setDescription(String value) { this.Description = value; return this; }
}
}
Java UpdateHomepageSettings DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateHomepageSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<AboutUsPageBody>String</AboutUsPageBody>
<AboutUsPageHeading>String</AboutUsPageHeading>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<EnableHomepage>false</EnableHomepage>
<HeroSectionStyleId>0</HeroSectionStyleId>
<HomePageTemplateId>0</HomePageTemplateId>
<HomepageHeading>String</HomepageHeading>
<ImageUrl i:nil="true" />
<ShowRating>false</ShowRating>
<WelcomePageBody>String</WelcomePageBody>
<WelcomePageHeading>String</WelcomePageHeading>
</UpdateHomepageSettings>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<HomepageSettingsQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<AboutUsPageBody>String</AboutUsPageBody>
<AboutUsPageHeading>String</AboutUsPageHeading>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Created>0001-01-01T00:00:00</Created>
<EnableHomepage>false</EnableHomepage>
<HeroSectionStyleId>0</HeroSectionStyleId>
<HomePageTemplateId>0</HomePageTemplateId>
<HomePageTemplateOptions>
<HomepageTemplateResponse>
<Description>String</Description>
<Id>0</Id>
<ImageUrl i:nil="true" />
<Name>String</Name>
</HomepageTemplateResponse>
</HomePageTemplateOptions>
<HomepageHeading>String</HomepageHeading>
<HomepageHeroSectionStyleOptions>
<HomepageHeroSectionStyleResponse>
<Description>String</Description>
<Id>0</Id>
<Name>String</Name>
</HomepageHeroSectionStyleResponse>
</HomepageHeroSectionStyleOptions>
<ImageUrl i:nil="true" />
<ShowRating>false</ShowRating>
<Updated>0001-01-01T00:00:00</Updated>
<WelcomePageBody>String</WelcomePageBody>
<WelcomePageHeading>String</WelcomePageHeading>
</HomepageSettingsQueryResponse>