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. The schema document itself (Schema, DefaultConfiguration, Version) is immutable: there is no PUT or DELETE for it. The only mutable field is MigrationFromPreviousVersion, set via PUT /widget/configurationschema/{Version}/migration.

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

Namespace Global

    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(Validator:="IsAuthenticated")>
        Public Partial Class CreateWidgetConfigurationSchema
            '''<Summary>
            '''The schema version. Must be unique.
            '''</Summary>
            <ApiMember(Description:="The schema version. Must be unique.", IsRequired:=true)>
            Public Overridable Property Version As Integer

            '''<Summary>
            '''The JSON Schema document.
            '''</Summary>
            <ApiMember(Description:="The JSON Schema document.", IsRequired:=true)>
            Public Overridable Property Schema As Dictionary(Of String, Object) = New Dictionary(Of String, Object)

            '''<Summary>
            '''Optional factory-default Configuration JSON for this schema version, used by the bump-version endpoint when UseFactoryDefaults=true. Must itself validate against Schema if provided.
            '''</Summary>
            <ApiMember(Description:="Optional factory-default Configuration JSON for this schema version, used by the bump-version endpoint when UseFactoryDefaults=true. Must itself validate against Schema if provided.")>
            Public Overridable Property DefaultConfiguration As String
        End Class

        Public Partial Class WidgetConfigurationSchemaResponse
            Public Overridable Property Id As Integer
            Public Overridable Property Version As Integer
            Public Overridable Property Schema As Dictionary(Of String, Object) = New Dictionary(Of String, Object)
            Public Overridable Property DefaultConfiguration As String
            Public Overridable Property MigrationFromPreviousVersion As String
            Public Overridable Property CreatedDate As Date
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET CreateWidgetConfigurationSchema DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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