| POST | /widget/configuration | Create a widget configuration | Creates a new widget configuration. The Configuration JSON is validated against the schema for SchemaVersion. |
|---|
import Foundation
import ServiceStack
// @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 class CreateWidgetConfiguration : ICompany, Codable
{
/**
* 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 var companyId:String?
/**
* The widget configuration name.
*/
// @ApiMember(Description="The widget configuration name.", IsRequired=true)
public var name:String
/**
* 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 var slug:String
/**
* Optional description.
*/
// @ApiMember(Description="Optional description.")
public var Description:String
/**
* 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 var configuration:String
/**
* Version of the configuration schema this Configuration adheres to.
*/
// @ApiMember(Description="Version of the configuration schema this Configuration adheres to.", IsRequired=true)
public var schemaVersion:Int
required public init(){}
}
public class WidgetConfigurationResponse : Codable
{
public var id:String
public var companyId:String
public var name:String
public var slug:String
public var Description:String
public var configuration:String
public var schemaVersion:Int
public var createdDate:Date
public var updatedDate:Date?
public var responseStatus:ResponseStatus
required public init(){}
}
Swift CreateWidgetConfiguration 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.
POST /widget/configuration HTTP/1.1
Host: testapi.bokamera.se
Accept: text/csv
Content-Type: text/csv
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/csv
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"}}}