Trendsic Platform Service

<back to all web services

MaterialRequest

Requires Authentication
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/Material/{MaterialID}
GET,POST,PUT,DELETE,OPTIONS/v1/Material
"use strict";
export class Project {
    /** @param {{ProjectID?:number,ProjectUID?:string,ProjectName?:string,ImageURL?:string,ImageKey?:string,ClientName?:string,ClientPhone?:string,ClientEmail?:string,ProjectManagerID?:number,ProjectManagerName?:string,StartDate?:string,EndDate?:string,ActualStartDate?:string,ActualEndDate?:string,JobCount?:number,CrewMemberCount?:number,EquipmentCount?:number,MaterialCount?:number,ProjectStatusID?:number,ProjectStatusDescription?:string,Budget?:number,CostToDate?:number,ProjectLocation?:string,ProjectType?:string,ProjectSponsor?:string,CreatedBy?:string,CreatedAt?:string,UpdatedAt?:string,ProjectDescription?:string,Scope?:string,StatusId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectID;
    /** @type {string} */
    ProjectUID;
    /** @type {string} */
    ProjectName;
    /** @type {string} */
    ImageURL;
    /** @type {string} */
    ImageKey;
    /** @type {string} */
    ClientName;
    /** @type {string} */
    ClientPhone;
    /** @type {string} */
    ClientEmail;
    /** @type {number} */
    ProjectManagerID;
    /** @type {string} */
    ProjectManagerName;
    /** @type {?string} */
    StartDate;
    /** @type {?string} */
    EndDate;
    /** @type {?string} */
    ActualStartDate;
    /** @type {?string} */
    ActualEndDate;
    /** @type {number} */
    JobCount;
    /** @type {number} */
    CrewMemberCount;
    /** @type {number} */
    EquipmentCount;
    /** @type {number} */
    MaterialCount;
    /** @type {number} */
    ProjectStatusID;
    /** @type {string} */
    ProjectStatusDescription;
    /** @type {number} */
    Budget;
    /** @type {number} */
    CostToDate;
    /** @type {string} */
    ProjectLocation;
    /** @type {string} */
    ProjectType;
    /** @type {string} */
    ProjectSponsor;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {?string} */
    UpdatedAt;
    /** @type {string} */
    ProjectDescription;
    /** @type {string} */
    Scope;
    /** @type {number} */
    StatusId;
}
export class Material {
    /** @param {{MaterialID?:number,MaterialName?:string,MaterialTypeID?:number,MaterialStatusID?:number,Quantity?:number,Supplier?:string,OrderDate?:string,DeliveryDate?:string,OnSiteDate?:string,MaterialLocation?:string,Manufacturer?:string,SerialNumber?:string,BarCode?:string,TrackingInfo?:string,MaterialDescription?:string,Notes?:string,ImageURL?:string,DetailsURL?:string,CreatedByUID?:string,Active?:boolean,RecordCreatedDate?:string,StatusId?:number,MaterialTypeName?:string,Cost?:number,Projects?:Project[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    MaterialID;
    /** @type {string} */
    MaterialName;
    /** @type {number} */
    MaterialTypeID;
    /** @type {number} */
    MaterialStatusID;
    /** @type {number} */
    Quantity;
    /** @type {string} */
    Supplier;
    /** @type {string} */
    OrderDate;
    /** @type {string} */
    DeliveryDate;
    /** @type {string} */
    OnSiteDate;
    /** @type {string} */
    MaterialLocation;
    /** @type {string} */
    Manufacturer;
    /** @type {string} */
    SerialNumber;
    /** @type {string} */
    BarCode;
    /** @type {string} */
    TrackingInfo;
    /** @type {string} */
    MaterialDescription;
    /** @type {string} */
    Notes;
    /** @type {string} */
    ImageURL;
    /** @type {string} */
    DetailsURL;
    /** @type {string} */
    CreatedByUID;
    /** @type {boolean} */
    Active;
    /** @type {string} */
    RecordCreatedDate;
    /** @type {number} */
    StatusId;
    /** @type {string} */
    MaterialTypeName;
    /** @type {number} */
    Cost;
    /** @type {Project[]} */
    Projects = [];
}
export class MaterialResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Material?:Material[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {Material[]} */
    Material = [];
}
export class MaterialRequest {
    /** @param {{MaterialID?:number,Material?:Material[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    MaterialID;
    /** @type {Material[]} */
    Material = [];
}

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

POST /v1/Material/{MaterialID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"MaterialID":0,"Material":[{"MaterialID":0,"MaterialName":"String","MaterialTypeID":0,"MaterialStatusID":0,"Quantity":0,"Supplier":"String","OrderDate":"0001-01-01T00:00:00.0000000","DeliveryDate":"0001-01-01T00:00:00.0000000","OnSiteDate":"0001-01-01T00:00:00.0000000","MaterialLocation":"String","Manufacturer":"String","SerialNumber":"String","BarCode":"String","TrackingInfo":"String","MaterialDescription":"String","Notes":"String","ImageURL":"String","DetailsURL":"String","CreatedByUID":"00000000000000000000000000000000","Active":false,"RecordCreatedDate":"0001-01-01T00:00:00.0000000","StatusId":0,"MaterialTypeName":"String","Cost":0,"Projects":[{"ProjectID":0,"ProjectUID":"00000000000000000000000000000000","ProjectName":"String","ImageURL":"String","ImageKey":"String","ClientName":"String","ClientPhone":"String","ClientEmail":"String","ProjectManagerID":0,"ProjectManagerName":"String","StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","ActualStartDate":"0001-01-01T00:00:00.0000000","ActualEndDate":"0001-01-01T00:00:00.0000000","JobCount":0,"CrewMemberCount":0,"EquipmentCount":0,"MaterialCount":0,"ProjectStatusID":0,"ProjectStatusDescription":"String","Budget":0,"CostToDate":0,"ProjectLocation":"String","ProjectType":"String","ProjectSponsor":"String","CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000","ProjectDescription":"String","Scope":"String","StatusId":0}]}]}

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

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Material":[{"MaterialID":0,"MaterialName":"String","MaterialTypeID":0,"MaterialStatusID":0,"Quantity":0,"Supplier":"String","OrderDate":"0001-01-01T00:00:00.0000000","DeliveryDate":"0001-01-01T00:00:00.0000000","OnSiteDate":"0001-01-01T00:00:00.0000000","MaterialLocation":"String","Manufacturer":"String","SerialNumber":"String","BarCode":"String","TrackingInfo":"String","MaterialDescription":"String","Notes":"String","ImageURL":"String","DetailsURL":"String","CreatedByUID":"00000000000000000000000000000000","Active":false,"RecordCreatedDate":"0001-01-01T00:00:00.0000000","StatusId":0,"MaterialTypeName":"String","Cost":0,"Projects":[{"ProjectID":0,"ProjectUID":"00000000000000000000000000000000","ProjectName":"String","ImageURL":"String","ImageKey":"String","ClientName":"String","ClientPhone":"String","ClientEmail":"String","ProjectManagerID":0,"ProjectManagerName":"String","StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","ActualStartDate":"0001-01-01T00:00:00.0000000","ActualEndDate":"0001-01-01T00:00:00.0000000","JobCount":0,"CrewMemberCount":0,"EquipmentCount":0,"MaterialCount":0,"ProjectStatusID":0,"ProjectStatusDescription":"String","Budget":0,"CostToDate":0,"ProjectLocation":"String","ProjectType":"String","ProjectSponsor":"String","CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000","ProjectDescription":"String","Scope":"String","StatusId":0}]}]}