| 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.*
@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")
open class CreateWidgetConfiguration : 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.")
override var CompanyId:UUID? = null
/**
* The widget configuration name.
*/
@ApiMember(Description="The widget configuration name.", IsRequired=true)
open var Name:String? = 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'.")
open var Slug:String? = null
/**
* Optional description.
*/
@ApiMember(Description="Optional description.")
open var Description:String? = 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)
open var Configuration:String? = null
/**
* Version of the configuration schema this Configuration adheres to.
*/
@ApiMember(Description="Version of the configuration schema this Configuration adheres to.", IsRequired=true)
open var SchemaVersion:Int? = null
}
open class WidgetConfigurationResponse
{
open var Id:String? = null
open var CompanyId:UUID? = null
open var Name:String? = null
open var Slug:String? = null
open var Description:String? = null
open var Configuration:String? = null
open var SchemaVersion:Int? = null
open var CreatedDate:Date? = null
open var UpdatedDate:Date? = null
open var ResponseStatus:ResponseStatus? = null
}
Kotlin CreateWidgetConfiguration 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.
POST /widget/configuration HTTP/1.1
Host: testapi.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
Name: String,
Slug: String,
Description: String,
Configuration: String,
SchemaVersion: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Id: String,
Name: String,
Slug: String,
Description: String,
Configuration: String,
SchemaVersion: 0,
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
}
}
}