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.

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 on the input parameters", StatusCode=400)]
    [ApiResponse(Description="Returned if the current user is not allowed to perform the action", StatusCode=401)]
    [ValidateRequest("IsAuthenticated")]
    public partial class CreateWidgetConfiguration
        : 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 virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///The widget configuration name.
        ///</summary>
        [ApiMember(Description="The widget configuration name.", IsRequired=true)]
        public virtual string Name { get; set; }

        ///<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 virtual string? Slug { get; set; }

        ///<summary>
        ///Optional description.
        ///</summary>
        [ApiMember(Description="Optional description.")]
        public virtual string? Description { get; set; }

        ///<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 virtual string Configuration { get; set; }

        ///<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 virtual int SchemaVersion { get; set; }
    }

    public partial class WidgetConfigurationResponse
    {
        public virtual string Id { get; set; }
        public virtual Guid CompanyId { get; set; }
        public virtual string Name { get; set; }
        public virtual string? Slug { get; set; }
        public virtual string? Description { get; set; }
        public virtual string Configuration { get; set; }
        public virtual int SchemaVersion { get; set; }
        public virtual DateTime CreatedDate { get; set; }
        public virtual DateTimeOffset? UpdatedDate { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# CreateWidgetConfiguration 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/configuration HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
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: text/jsv
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
		}
	}
}