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 java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

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

        /**
        * The JSON Schema document.
        */
        @ApiMember(Description="The JSON Schema document.", IsRequired=true)
        public HashMap<String,Object> Schema = new HashMap<String,Object>();
        
        public Integer getVersion() { return Version; }
        public CreateWidgetConfigurationSchema setVersion(Integer value) { this.Version = value; return this; }
        public HashMap<String,Object> getSchema() { return Schema; }
        public CreateWidgetConfigurationSchema setSchema(HashMap<String,Object> value) { this.Schema = value; return this; }
    }

    public static class WidgetConfigurationSchemaResponse
    {
        public Integer Id = null;
        public Integer Version = null;
        public HashMap<String,Object> Schema = new HashMap<String,Object>();
        public Date CreatedDate = null;
        public ResponseStatus ResponseStatus = null;
        
        public Integer getId() { return Id; }
        public WidgetConfigurationSchemaResponse setId(Integer value) { this.Id = value; return this; }
        public Integer getVersion() { return Version; }
        public WidgetConfigurationSchemaResponse setVersion(Integer value) { this.Version = value; return this; }
        public HashMap<String,Object> getSchema() { return Schema; }
        public WidgetConfigurationSchemaResponse setSchema(HashMap<String,Object> value) { this.Schema = value; return this; }
        public Date getCreatedDate() { return CreatedDate; }
        public WidgetConfigurationSchemaResponse setCreatedDate(Date value) { this.CreatedDate = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public WidgetConfigurationSchemaResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java 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>