| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| PUT | /widget/configuration/{Id}/bumpversion | Bump the homepage default widget configuration to the next schema version | Moves the homepage default configuration's SchemaVersion to SchemaVersion + 1. Returns 400 if the next version's schema does not exist yet, if UseFactoryDefaults is true and the next version has no DefaultConfiguration authored, or if the target configuration is not the homepage default. |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
@ApiResponse(Description="Not the homepage default, next schema version doesn't exist, or (when UseFactoryDefaults) the next version has no factory default authored yet", 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 BumpWidgetConfigurationVersion 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;
/**
* When true, overwrites Configuration with the next schema version's factory-default JSON. When false, only SchemaVersion is moved and the existing Configuration is preserved unvalidated against the new schema.
*/
@ApiMember(Description="When true, overwrites Configuration with the next schema version's factory-default JSON. When false, only SchemaVersion is moved and the existing Configuration is preserved unvalidated against the new schema.", IsRequired=true)
public Boolean UseFactoryDefaults = null;
public UUID getCompanyId() { return CompanyId; }
public BumpWidgetConfigurationVersion setCompanyId(UUID value) { this.CompanyId = value; return this; }
public String getId() { return Id; }
public BumpWidgetConfigurationVersion setId(String value) { this.Id = value; return this; }
public Boolean isUseFactoryDefaults() { return UseFactoryDefaults; }
public BumpWidgetConfigurationVersion setUseFactoryDefaults(Boolean value) { this.UseFactoryDefaults = 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 BumpWidgetConfigurationVersion DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /widget/configuration/{Id}/bumpversion HTTP/1.1
Host: api.bookmore.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"CompanyId":"00000000-0000-0000-0000-000000000000","Id":"String","UseFactoryDefaults":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Id":"String","Name":"String","Slug":"String","Description":"String","Configuration":"String","SchemaVersion":0,"IsHomepageDefault":false,"UpdatedDate":"0001-01-01T00:00:00.0000000+00:00","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}