Trendsic Platform Service

<back to all web services

MaterialShortfallsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/projects/{ProjectID}/material-shortfalls

export class MaterialShortfall
{
    public MaterialID: number;
    public Name: string;
    public MaterialType: string;
    public OnHand: number;
    public QtyNeeded: number;
    public ShortQty: number;
    public Unit: string;
    public UnitPrice: number;
    public EstUSD: number;
    public Vendor: string;
    public JobStartDate?: string;

    public constructor(init?: Partial<MaterialShortfall>) { (Object as any).assign(this, init); }
}

export class MaterialShortfallsResponse
{
    public ResponseStatus: ResponseStatus;
    public ProjectID: number;
    public Shortfalls: MaterialShortfall[] = [];

    public constructor(init?: Partial<MaterialShortfallsResponse>) { (Object as any).assign(this, init); }
}

export class MaterialShortfallsRequest
{
    public ProjectID: number;

    public constructor(init?: Partial<MaterialShortfallsRequest>) { (Object as any).assign(this, init); }
}

TypeScript MaterialShortfallsRequest 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/projects/{ProjectID}/material-shortfalls HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
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"}},"ProjectID":0,"Shortfalls":[{"MaterialID":0,"Name":"String","MaterialType":"String","OnHand":0,"QtyNeeded":0,"ShortQty":0,"Unit":"String","UnitPrice":0,"EstUSD":0,"Vendor":"String","JobStartDate":"0001-01-01T00:00:00.0000000"}]}