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.

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)
        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 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 .other suffix or ?format=other

HTTP + OTHER

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

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

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