BokaMera.API.Host

<back to all web services

CreateWidgetConfigurationSchema

Requires Authentication
Requires the role:superadmin
The following routes are available for this service:
POST/widget/configurationschemaCreate a widget configuration schemaCreates a new schema. SuperAdmin only. Schemas are global and immutable: there is no PUT or DELETE.
"use strict";
export class WidgetConfigurationSchemaResponse {
    /** @param {{Id?:number,Version?:number,Schema?:{ [index:string]: Object; },CreatedDate?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {number} */
    Version;
    /** @type {{ [index:string]: Object; }} */
    Schema = {};
    /** @type {string} */
    CreatedDate;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class CreateWidgetConfigurationSchema {
    /** @param {{Version?:number,Schema?:{ [index:string]: Object; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The schema version. Must be unique. */
    Version;
    /**
     * @type {{ [index:string]: Object; }}
     * @description The JSON Schema document. */
    Schema = {};
}

JavaScript CreateWidgetConfigurationSchema DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /widget/configurationschema HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Version":0,"Schema":{"String":{}}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"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"}}}