BokaMera.API.Host

CreateWidgetConfigurationSchema

**Requires Authentication**
Requires the role:	superadmin

The following routes are available for this service:
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.

import 'package:servicestack/servicestack.dart';

class WidgetConfigurationSchemaResponse implements IConvertible
{
    int Id = 0;
    int Version = 0;
    Map<String,dynamic?> Schema = {};
    DateTime CreatedDate = DateTime(0);
    ResponseStatus ResponseStatus;

    WidgetConfigurationSchemaResponse({this.Id,this.Version,this.Schema,this.CreatedDate,this.ResponseStatus});
    WidgetConfigurationSchemaResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Version = json['Version'];
        Schema = JsonConverters.fromJson(json['Schema'],'Map<String,dynamic?>',context!);
        CreatedDate = JsonConverters.fromJson(json['CreatedDate'],'DateTime',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Version': Version,
        'Schema': JsonConverters.toJson(Schema,'Map<String,dynamic?>',context!),
        'CreatedDate': JsonConverters.toJson(CreatedDate,'DateTime',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "WidgetConfigurationSchemaResponse";
    TypeContext? context = _ctx;
}

// @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")
class CreateWidgetConfigurationSchema implements IConvertible
{
    /**
    * The schema version. Must be unique.
    */
    // @ApiMember(Description="The schema version. Must be unique.", IsRequired=true)
    int Version = 0;

    /**
    * The JSON Schema document.
    */
    // @ApiMember(Description="The JSON Schema document.", IsRequired=true)
    Map<String,dynamic?> Schema = {};

    CreateWidgetConfigurationSchema({this.Version,this.Schema});
    CreateWidgetConfigurationSchema.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Version = json['Version'];
        Schema = JsonConverters.fromJson(json['Schema'],'Map<String,dynamic?>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Version': Version,
        'Schema': JsonConverters.toJson(Schema,'Map<String,dynamic?>',context!)
    };

    getTypeName() => "CreateWidgetConfigurationSchema";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'testapi.bokamera.se', types: <String, TypeInfo> {
    'WidgetConfigurationSchemaResponse': TypeInfo(TypeOf.Class, create:() => WidgetConfigurationSchemaResponse()),
    'Map<String,dynamic?>': TypeInfo(TypeOf.Class, create:() => Map<String,dynamic?>()),
    'CreateWidgetConfigurationSchema': TypeInfo(TypeOf.Class, create:() => CreateWidgetConfigurationSchema()),
});

Dart CreateWidgetConfigurationSchema DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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>