BokaMera.API.Host

<back to all web services

CreateWidgetConfigurationSchema

Requires Authentication
Requires the role:superadmin
The following routes are available for this service:
POST/widget/configurationschemaCreate a widget configuration schemaCreates 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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"Version":0,"Schema":{"String":{}}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Id":0,"Version":0,"Schema":{"String":{}},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}