BokaMera.API.Host

<back to all web services

UpdateWidgetConfiguration

Requires Authentication
The following routes are available for this service:
PUT/widget/configuration/{Id}Update a widget configurationUpdates an existing widget configuration. The Configuration JSON is re-validated against the schema for SchemaVersion.
"use strict";
export class WidgetConfigurationResponse {
    /** @param {{Id?:string,CompanyId?:string,Name?:string,Slug?:string,Description?:string,Configuration?:string,SchemaVersion?:number,CreatedDate?:string,UpdatedDate?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    CompanyId;
    /** @type {string} */
    Name;
    /** @type {?string} */
    Slug;
    /** @type {?string} */
    Description;
    /** @type {string} */
    Configuration;
    /** @type {number} */
    SchemaVersion;
    /** @type {string} */
    CreatedDate;
    /** @type {?string} */
    UpdatedDate;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class UpdateWidgetConfiguration {
    /** @param {{CompanyId?:string,Id?:string,Name?:string,Slug?:string,Description?:string,Configuration?:string,SchemaVersion?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
    /**
     * @type {string}
     * @description The widget configuration id (6-character NanoID). */
    Id;
    /**
     * @type {string}
     * @description The widget configuration name. */
    Name;
    /**
     * @type {?string}
     * @description Optional slug (URL-friendly identifier). The API will append the last 3 characters of the company ID. Example: 'hairsalon' becomes 'hairsalon-001'. */
    Slug;
    /**
     * @type {?string}
     * @description Optional description. */
    Description;
    /**
     * @type {string}
     * @description The widget configuration as a JSON string. Must validate against the schema for SchemaVersion. */
    Configuration;
    /**
     * @type {number}
     * @description Version of the configuration schema this Configuration adheres to. */
    SchemaVersion;
}

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

PUT /widget/configuration/{Id} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Id":"String","Name":"String","Slug":"String","Description":"String","Configuration":"String","SchemaVersion":0}

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

{"Id":"String","Name":"String","Slug":"String","Description":"String","Configuration":"String","SchemaVersion":0,"UpdatedDate":"0001-01-01T00:00:00.0000000+00:00","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}