BokaMera.API.Host

CreateWidgetConfigurationSchema

**Requires Authentication**
Requires the role:	superadmin

The following routes are available for this service:
POST	/widget/configurationschema	Create a widget configuration schema	Creates a new schema. SuperAdmin only. Schemas are global and immutable: there is no PUT or DELETE.

// @ts-nocheck

export class WidgetConfigurationSchemaResponse
{
    public Id: number;
    public Version: number;
    public Schema: { [index:string]: Object; } = {};
    public CreatedDate: string;
    public ResponseStatus: ResponseStatus;

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

// @ApiResponse(Description="Returned if there is a validation error or the schema is invalid JSON Schema", StatusCode=400)
// @ApiResponse(Description="Returned if a schema with this Version already exists", StatusCode=409)
// @ApiResponse(Description="Returned if the current user is not a SuperAdmin", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class CreateWidgetConfigurationSchema
{
    /** @description The schema version. Must be unique. */
    // @ApiMember(Description="The schema version. Must be unique.", IsRequired=true)
    public Version: number;

    /** @description The JSON Schema document. */
    // @ApiMember(Description="The JSON Schema document.", IsRequired=true)
    public Schema: { [index:string]: Object; } = {};

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

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