BokaMera.API.Host

CreateWidgetConfiguration

The following routes are available for this service:
POST	/widget/configuration	Create a widget configuration	Creates a new widget configuration. The Configuration JSON is 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 CreateWidgetConfiguration {
    /** @param {{CompanyId?: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 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 CreateWidgetConfiguration DTOs

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

HTTP + XML

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

POST /widget/configuration HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateWidgetConfiguration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Configuration>String</Configuration>
  <Description>String</Description>
  <Name>String</Name>
  <SchemaVersion>0</SchemaVersion>
  <Slug>String</Slug>
</CreateWidgetConfiguration>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WidgetConfigurationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Configuration>String</Configuration>
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <Description>String</Description>
  <Id>String</Id>
  <Name>String</Name>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <SchemaVersion>0</SchemaVersion>
  <Slug>String</Slug>
  <UpdatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </UpdatedDate>
</WidgetConfigurationResponse>