BokaMera.API.Host

WidgetConfigurationSchemaQuery

The following routes are available for this service:
GET	/widget/configurationschema	List widget configuration schemas	Returns all known configuration schemas. Schemas are global (not company-scoped) and immutable per Version.

import Foundation
import ServiceStack

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
public class WidgetConfigurationSchemaQuery : Codable
{
    /**
    * Filter by version.
    */
    // @ApiMember(Description="Filter by version.")
    public var version:Int?

    /**
    * Number of records to skip
    */
    // @ApiMember(Description="Number of records to skip")
    public var skip:Int?

    /**
    * Number of records to take
    */
    // @ApiMember(Description="Number of records to take")
    public var take:Int?

    required public init(){}
}

public class AccessKeyTypeResponse : Codable
{
    public var id:Int
    public var keyType:String
    public var Description:String

    required public init(){}
}

Swift WidgetConfigurationSchemaQuery 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.

GET /widget/configurationschema HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			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
				}
			}
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}