BokaMera.API.Host

<back to all web services

GetVossProducts

The following routes are available for this service:
GET/voss/productsgets voss products
"use strict";
/** @typedef {number} */
export var TypeEnum;
(function (TypeEnum) {
    TypeEnum[TypeEnum["Main"] = 1] = "Main"
    TypeEnum[TypeEnum["Addon"] = 2] = "Addon"
    TypeEnum[TypeEnum["License"] = 3] = "License"
    TypeEnum[TypeEnum["Usage"] = 4] = "Usage"
})(TypeEnum || (TypeEnum = {}));
/** @typedef {number} */
export var StatusEnum;
(function (StatusEnum) {
    StatusEnum[StatusEnum["Published"] = 1] = "Published"
    StatusEnum[StatusEnum["Disabled"] = 2] = "Disabled"
})(StatusEnum || (StatusEnum = {}));
export class ProductResultProductFamilyDto {
    /** @param {{id?:string,externalId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    id;
    /** @type {string} */
    externalId;
}
export class ProductResult {
    /** @param {{type?:TypeEnum,status?:StatusEnum,id?:string,name?:string,externalId?:string,articleNumber?:string,productFamily?:ProductResultProductFamilyDto}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {TypeEnum} */
    type;
    /** @type {StatusEnum} */
    status;
    /** @type {string} */
    id;
    /** @type {string} */
    name;
    /** @type {string} */
    externalId;
    /** @type {string} */
    articleNumber;
    /** @type {ProductResultProductFamilyDto} */
    productFamily;
}
export class SearchProductsResult {
    /** @param {{items?:ProductResult[],totalCount?:number,pageIndex?:number,pageSize?:number,totalPages?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ProductResult[]} */
    items;
    /** @type {number} */
    totalCount;
    /** @type {number} */
    pageIndex;
    /** @type {number} */
    pageSize;
    /** @type {number} */
    totalPages;
}
export class GetVossProducts {
    /** @param {{CompanyId?:string}} [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;
}

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

GET /voss/products HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml

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

<SearchProductsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VossIntegration.ApiTools.Model">
  <items>
    <ProductResult i:nil="true" />
  </items>
</SearchProductsResult>