| Requires the role: | superadmin |
| POST | /widget/configurationschema | Create a widget configuration schema | Creates a new schema. SuperAdmin only. Schemas are global and immutable: there is no PUT or DELETE. |
|---|
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 WidgetConfigurationSchemaResponse() =
member val Id:Int32 = new Int32() with get,set
member val Version:Int32 = new Int32() with get,set
member val Schema:Dictionary<String, Object> = null with get,set
member val CreatedDate:DateTime = new DateTime() with get,set
member val ResponseStatus:ResponseStatus = null with get,set
[<ApiResponse(Description="Returned if there is a validation error or the schema is invalid JSON Schema", StatusCode=400)>]
[<ApiResponse(Description="Returned if a schema with this Version already exists", StatusCode=409)>]
[<ApiResponse(Description="Returned if the current user is not a SuperAdmin", StatusCode=401)>]
[<ValidateRequest(Validator="IsAuthenticated")>]
[<AllowNullLiteral>]
type CreateWidgetConfigurationSchema() =
///<summary>
///The schema version. Must be unique.
///</summary>
[<ApiMember(Description="The schema version. Must be unique.", IsRequired=true)>]
member val Version:Int32 = new Int32() with get,set
///<summary>
///The JSON Schema document.
///</summary>
[<ApiMember(Description="The JSON Schema document.", IsRequired=true)>]
member val Schema:Dictionary<String, Object> = null with get,set
F# CreateWidgetConfigurationSchema 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/configurationschema HTTP/1.1
Host: testapi.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CreateWidgetConfigurationSchema xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Schema xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringanyType>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value />
</d2p1:KeyValueOfstringanyType>
</Schema>
<Version>0</Version>
</CreateWidgetConfigurationSchema>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<WidgetConfigurationSchemaResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<Id>0</Id>
<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>
<Schema xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringanyType>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value />
</d2p1:KeyValueOfstringanyType>
</Schema>
<Version>0</Version>
</WidgetConfigurationSchemaResponse>