| POST | /widget/configuration | Create a widget configuration | Creates a new widget configuration. The Configuration JSON is validated against the schema for SchemaVersion. |
|---|
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 current user is not allowed to perform the action", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
public static class CreateWidgetConfiguration 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 name.
*/
@ApiMember(Description="The widget configuration name.", IsRequired=true)
public String Name = null;
/**
* Optional slug (URL-friendly identifier). The API will append the last 3 characters of the company ID. Example: 'hairsalon' becomes 'hairsalon-001'.
*/
@ApiMember(Description="Optional slug (URL-friendly identifier). The API will append the last 3 characters of the company ID. Example: 'hairsalon' becomes 'hairsalon-001'.")
public String Slug = null;
/**
* Optional description.
*/
@ApiMember(Description="Optional description.")
public String Description = null;
/**
* The widget configuration as a JSON string. Must validate against the schema for SchemaVersion.
*/
@ApiMember(Description="The widget configuration as a JSON string. Must validate against the schema for SchemaVersion.", IsRequired=true)
public String Configuration = null;
/**
* Version of the configuration schema this Configuration adheres to.
*/
@ApiMember(Description="Version of the configuration schema this Configuration adheres to.", IsRequired=true)
public Integer SchemaVersion = null;
public UUID getCompanyId() { return CompanyId; }
public CreateWidgetConfiguration setCompanyId(UUID value) { this.CompanyId = value; return this; }
public String getName() { return Name; }
public CreateWidgetConfiguration setName(String value) { this.Name = value; return this; }
public String getSlug() { return Slug; }
public CreateWidgetConfiguration setSlug(String value) { this.Slug = value; return this; }
public String getDescription() { return Description; }
public CreateWidgetConfiguration setDescription(String value) { this.Description = value; return this; }
public String getConfiguration() { return Configuration; }
public CreateWidgetConfiguration setConfiguration(String value) { this.Configuration = value; return this; }
public Integer getSchemaVersion() { return SchemaVersion; }
public CreateWidgetConfiguration setSchemaVersion(Integer value) { this.SchemaVersion = 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 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 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 CreateWidgetConfiguration 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.
POST /widget/configuration HTTP/1.1
Host: testapi.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CreateWidgetConfiguration 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>
<Description>String</Description>
<Name>String</Name>
<SchemaVersion>0</SchemaVersion>
<Slug>String</Slug>
</CreateWidgetConfiguration>
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>
<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>