Trendsic Platform Service

MaterialShortfallsRequest

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

"use strict";
export class MaterialShortfall {
    /** @param {{MaterialID?:number,Name?:string,MaterialType?:string,OnHand?:number,QtyNeeded?:number,ShortQty?:number,Unit?:string,UnitPrice?:number,EstUSD?:number,Vendor?:string,JobStartDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    MaterialID;
    /** @type {string} */
    Name;
    /** @type {string} */
    MaterialType;
    /** @type {number} */
    OnHand;
    /** @type {number} */
    QtyNeeded;
    /** @type {number} */
    ShortQty;
    /** @type {string} */
    Unit;
    /** @type {number} */
    UnitPrice;
    /** @type {number} */
    EstUSD;
    /** @type {string} */
    Vendor;
    /** @type {?string} */
    JobStartDate;
}
export class MaterialShortfallsResponse {
    /** @param {{ResponseStatus?:ResponseStatus,ProjectID?:number,Shortfalls?:MaterialShortfall[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {number} */
    ProjectID;
    /** @type {MaterialShortfall[]} */
    Shortfalls = [];
}
export class MaterialShortfallsRequest {
    /** @param {{ProjectID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectID;
}

JavaScript MaterialShortfallsRequest DTOs

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

HTTP + JSV

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: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
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-01
		}
	]
}