BokaMera.API.Host

CreateWidgetConfiguration

The following routes are available for this service:
POST	/widget/configuration	Create a widget configuration	Creates a new widget configuration. The Configuration JSON is validated against the schema for SchemaVersion.

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 on the input parameters", StatusCode:=400)>
        <ApiResponse(Description:="Returned if the current user is not allowed to perform the action", StatusCode:=401)>
        <ValidateRequest(Validator:="IsAuthenticated")>
        Public Partial Class CreateWidgetConfiguration
            Implements ICompany
            '''<Summary>
            '''The company id, if empty will use the company id for the user you are logged in with.
            '''</Summary>
            <ApiMember(Description:="The company id, if empty will use the company id for the user you are logged in with.")>
            Public Overridable Property CompanyId As Guid? Implements ICompany.CompanyId

            '''<Summary>
            '''The widget configuration name.
            '''</Summary>
            <ApiMember(Description:="The widget configuration name.", IsRequired:=true)>
            Public Overridable Property Name As String

            '''<Summary>
            '''Optional slug (URL-friendly identifier). The API will append the last 3 characters of the company ID. Example: 'hairsalon' becomes 'hairsalon-001'.
            '''</Summary>
            <ApiMember(Description:="Optional slug (URL-friendly identifier). The API will append the last 3 characters of the company ID. Example: 'hairsalon' becomes 'hairsalon-001'.")>
            Public Overridable Property Slug As String

            '''<Summary>
            '''Optional description.
            '''</Summary>
            <ApiMember(Description:="Optional description.")>
            Public Overridable Property Description As String

            '''<Summary>
            '''The widget configuration as a JSON string. Must validate against the schema for SchemaVersion.
            '''</Summary>
            <ApiMember(Description:="The widget configuration as a JSON string. Must validate against the schema for SchemaVersion.", IsRequired:=true)>
            Public Overridable Property Configuration As String

            '''<Summary>
            '''Version of the configuration schema this Configuration adheres to.
            '''</Summary>
            <ApiMember(Description:="Version of the configuration schema this Configuration adheres to.", IsRequired:=true)>
            Public Overridable Property SchemaVersion As Integer
        End Class

        Public Partial Class WidgetConfigurationResponse
            Public Overridable Property Id As String
            Public Overridable Property CompanyId As Guid
            Public Overridable Property Name As String
            Public Overridable Property Slug As String
            Public Overridable Property Description As String
            Public Overridable Property Configuration As String
            Public Overridable Property SchemaVersion As Integer
            Public Overridable Property CreatedDate As Date
            Public Overridable Property UpdatedDate As DateTimeOffset?
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET CreateWidgetConfiguration 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/configuration HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Name":"String","Slug":"String","Description":"String","Configuration":"String","SchemaVersion":0}

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

{"Id":"String","Name":"String","Slug":"String","Description":"String","Configuration":"String","SchemaVersion":0,"UpdatedDate":"0001-01-01T00:00:00.0000000+00:00","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}