| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| PUT | /widget/configuration/{Id}/sethomepage | Set a widget configuration as the homepage default | Makes the supplied configuration the company's homepage default and removes the flag from the previous one. Slugs are left unchanged. Calling it on the current homepage default is a no-op success. |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
@ApiResponse(Description="Returned if there is a validation error on the input parameters", StatusCode=400)
// @ApiResponse(Description="Returned if the configuration was not found", StatusCode=404)
// @ApiResponse(Description="Returned if the current user is not allowed to perform the action", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
public static class SetHomepageWidgetConfiguration implements ICompany
{
/**
* 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.")
public UUID CompanyId = null;
/**
* The widget configuration id (6-character NanoID).
*/
@ApiMember(Description="The widget configuration id (6-character NanoID).", IsRequired=true, ParameterType="path")
public String Id = null;
public UUID getCompanyId() { return CompanyId; }
public SetHomepageWidgetConfiguration setCompanyId(UUID value) { this.CompanyId = value; return this; }
public String getId() { return Id; }
public SetHomepageWidgetConfiguration setId(String value) { this.Id = value; return this; }
}
public static class WidgetConfigurationResponse
{
public String Id = null;
public UUID CompanyId = null;
public String Name = null;
public String Slug = null;
public String Description = null;
public String Configuration = null;
public Integer SchemaVersion = null;
public Boolean IsHomepageDefault = null;
public Date CreatedDate = null;
public Date UpdatedDate = null;
public ResponseStatus ResponseStatus = null;
public String getId() { return Id; }
public WidgetConfigurationResponse setId(String value) { this.Id = value; return this; }
public UUID getCompanyId() { return CompanyId; }
public WidgetConfigurationResponse setCompanyId(UUID value) { this.CompanyId = value; return this; }
public String getName() { return Name; }
public WidgetConfigurationResponse setName(String value) { this.Name = value; return this; }
public String getSlug() { return Slug; }
public WidgetConfigurationResponse setSlug(String value) { this.Slug = value; return this; }
public String getDescription() { return Description; }
public WidgetConfigurationResponse setDescription(String value) { this.Description = value; return this; }
public String getConfiguration() { return Configuration; }
public WidgetConfigurationResponse setConfiguration(String value) { this.Configuration = value; return this; }
public Integer getSchemaVersion() { return SchemaVersion; }
public WidgetConfigurationResponse setSchemaVersion(Integer value) { this.SchemaVersion = value; return this; }
public Boolean getIsHomepageDefault() { return IsHomepageDefault; }
public WidgetConfigurationResponse setIsHomepageDefault(Boolean value) { this.IsHomepageDefault = value; return this; }
public Date getCreatedDate() { return CreatedDate; }
public WidgetConfigurationResponse setCreatedDate(Date value) { this.CreatedDate = value; return this; }
public Date getUpdatedDate() { return UpdatedDate; }
public WidgetConfigurationResponse setUpdatedDate(Date value) { this.UpdatedDate = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public WidgetConfigurationResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
}
Java SetHomepageWidgetConfiguration 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 /widget/configuration/{Id}/sethomepage HTTP/1.1
Host: testapi.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SetHomepageWidgetConfiguration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Id>String</Id>
</SetHomepageWidgetConfiguration>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<WidgetConfigurationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Configuration>String</Configuration>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<Description>String</Description>
<Id>String</Id>
<IsHomepageDefault>false</IsHomepageDefault>
<Name>String</Name>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<SchemaVersion>0</SchemaVersion>
<Slug>String</Slug>
<UpdatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</UpdatedDate>
</WidgetConfigurationResponse>