| POST | /widget/configuration | Create a widget configuration | Creates a new widget configuration. The Configuration JSON is validated against the schema for SchemaVersion. |
|---|
namespace BokaMera.API.ServiceModel.Dtos
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type WidgetConfigurationResponse() =
member val Id:String = null with get,set
member val CompanyId:Guid = new Guid() with get,set
member val Name:String = null with get,set
member val Slug:String = null with get,set
member val Description:String = null with get,set
member val Configuration:String = null with get,set
member val SchemaVersion:Int32 = new Int32() with get,set
member val CreatedDate:DateTime = new DateTime() with get,set
member val UpdatedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
member val ResponseStatus:ResponseStatus = null with get,set
[<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")>]
[<AllowNullLiteral>]
type CreateWidgetConfiguration() =
///<summary>
///The company id, if empty will use the company id for the user you are logged in with.
///</summary>
[<ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")>]
member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///The widget configuration name.
///</summary>
[<ApiMember(Description="The widget configuration name.", IsRequired=true)>]
member val Name:String = null with get,set
///<summary>
///Optional slug (URL-friendly identifier). The API will append the last 3 characters of the company ID. Example: 'hairsalon' becomes 'hairsalon-001'.
///</summary>
[<ApiMember(Description="Optional slug (URL-friendly identifier). The API will append the last 3 characters of the company ID. Example: 'hairsalon' becomes 'hairsalon-001'.")>]
member val Slug:String = null with get,set
///<summary>
///Optional description.
///</summary>
[<ApiMember(Description="Optional description.")>]
member val Description:String = null with get,set
///<summary>
///The widget configuration as a JSON string. Must validate against the schema for SchemaVersion.
///</summary>
[<ApiMember(Description="The widget configuration as a JSON string. Must validate against the schema for SchemaVersion.", IsRequired=true)>]
member val Configuration:String = null with get,set
///<summary>
///Version of the configuration schema this Configuration adheres to.
///</summary>
[<ApiMember(Description="Version of the configuration schema this Configuration adheres to.", IsRequired=true)>]
member val SchemaVersion:Int32 = new Int32() with get,set
F# 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"}}}