Trendsic Platform Service

<back to all web services

PmCatalogRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/pm/catalog
"use strict";
export class PmCatalogItem {
    /** @param {{Id?:number,Name?:string,Amount?:number,Subtext?:string,Badge?:string,BadgeKind?:string,OnHand?:number,Unit?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Name;
    /** @type {number} */
    Amount;
    /** @type {string} */
    Subtext;
    /** @type {string} */
    Badge;
    /** @type {string} */
    BadgeKind;
    /** @type {number} */
    OnHand;
    /** @type {string} */
    Unit;
}
export class PmCatalogCrew {
    /** @param {{Id?:number,Name?:string,MemberIds?:number[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Name;
    /** @type {number[]} */
    MemberIds = [];
}
export class PmCatalogResponse {
    /** @param {{Statuses?:PmCatalogItem[],Crew?:PmCatalogItem[],Crews?:PmCatalogCrew[],Equipment?:PmCatalogItem[],Materials?:PmCatalogItem[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {PmCatalogItem[]} */
    Statuses = [];
    /** @type {PmCatalogItem[]} */
    Crew = [];
    /** @type {PmCatalogCrew[]} */
    Crews = [];
    /** @type {PmCatalogItem[]} */
    Equipment = [];
    /** @type {PmCatalogItem[]} */
    Materials = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class PmCatalogRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript PmCatalogRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /v1/pm/catalog HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json

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

{"Statuses":[{"Id":0,"Name":"String","Amount":0,"Subtext":"String","Badge":"String","BadgeKind":"String","OnHand":0,"Unit":"String"}],"Crew":[{"Id":0,"Name":"String","Amount":0,"Subtext":"String","Badge":"String","BadgeKind":"String","OnHand":0,"Unit":"String"}],"Crews":[{"Id":0,"Name":"String","MemberIds":[0]}],"Equipment":[{"Id":0,"Name":"String","Amount":0,"Subtext":"String","Badge":"String","BadgeKind":"String","OnHand":0,"Unit":"String"}],"Materials":[{"Id":0,"Name":"String","Amount":0,"Subtext":"String","Badge":"String","BadgeKind":"String","OnHand":0,"Unit":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}