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.

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;

namespace BokaMera.API.ServiceModel.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("IsAuthenticated")]
    public partial class CreateWidgetConfigurationSchema
    {
        ///<summary>
        ///The schema version. Must be unique.
        ///</summary>
        [ApiMember(Description="The schema version. Must be unique.", IsRequired=true)]
        public virtual int Version { get; set; }

        ///<summary>
        ///The JSON Schema document.
        ///</summary>
        [ApiMember(Description="The JSON Schema document.", IsRequired=true)]
        public virtual Dictionary<string, Object> Schema { get; set; } = new();
    }

    public partial class WidgetConfigurationSchemaResponse
    {
        public virtual int Id { get; set; }
        public virtual int Version { get; set; }
        public virtual Dictionary<string, Object> Schema { get; set; } = new();
        public virtual DateTime CreatedDate { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# CreateWidgetConfigurationSchema DTOs

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

HTTP + JSV

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

{
	Version: 0,
	Schema: 
	{
		String: {}
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}