BokaMera.API.Host

<back to all web services

WidgetConfigurationSchemaQuery

Requires Authentication
The following routes are available for this service:
GET/widget/configurationschemaList widget configuration schemasReturns all known configuration schemas. Schemas are global (not company-scoped) and immutable per Version.
"use strict";
export class WidgetConfigurationSchemaQuery {
    /** @param {{Version?:number,Skip?:number,Take?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?number}
     * @description Filter by version. */
    Version;
    /**
     * @type {?number}
     * @description Number of records to skip */
    Skip;
    /**
     * @type {?number}
     * @description Number of records to take */
    Take;
}
export class AccessKeyTypeResponse {
    /** @param {{Id?:number,KeyType?:string,Description?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    KeyType;
    /** @type {string} */
    Description;
}
/** @typedef T {any} */
export class QueryResponse {
    /** @param {{Offset?:number,Total?:number,Results?:T[],Meta?:{ [index:string]: string; },ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Offset;
    /** @type {number} */
    Total;
    /** @type {T[]} */
    Results = [];
    /** @type {?{ [index:string]: string; }} */
    Meta;
    /** @type {?ResponseStatus} */
    ResponseStatus;
}

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

GET /widget/configurationschema HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/json

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