BokaMera.API.Host

WidgetConfigurationSchemaQuery

The following routes are available for this service:
GET	/widget/configurationschema	List widget configuration schemas	Returns all known configuration schemas, sortable via OrderBy. Schemas are global (not company-scoped); the schema document itself (Schema, DefaultConfiguration) is immutable per Version. The one exception is MigrationFromPreviousVersion, which can be set/replaced via PUT /widget/configurationschema/{Version}/migration.

// @ts-nocheck

export class WidgetConfigurationSchemaQuery
{
    /** @description Filter by version. */
    // @ApiMember(Description="Filter by version.")
    public Version?: number;

    /** @description Number of records to skip */
    // @ApiMember(Description="Number of records to skip")
    public Skip?: number;

    /** @description Number of records to take */
    // @ApiMember(Description="Number of records to take")
    public Take?: number;

    /** @description Sort field, e.g. 'Version' or '-Version' for descending. Allowed: Id, Version, CreatedDate. */
    // @ApiMember(Description="Sort field, e.g. 'Version' or '-Version' for descending. Allowed: Id, Version, CreatedDate.")
    public OrderBy: string;

    public constructor(init?: Partial<WidgetConfigurationSchemaQuery>) { (Object as any).assign(this, init); }
}

export class AccessKeyTypeResponse
{
    public Id: number;
    public KeyType: string;
    public Description: string;

    public constructor(init?: Partial<AccessKeyTypeResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class QueryResponse<T>
{
    // @DataMember(Order=1)
    public Offset: number;

    // @DataMember(Order=2)
    public Total: number;

    // @DataMember(Order=3)
    public Results: AccessKeyTypeResponse[] = [];

    // @DataMember(Order=4)
    public Meta?: { [index:string]: string; };

    // @DataMember(Order=5)
    public ResponseStatus?: ResponseStatus;

    public constructor(init?: Partial<QueryResponse<T>>) { (Object as any).assign(this, init); }
}

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

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

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

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