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
MaterialShortfallsRequest Parameters:
NameParameterData TypeRequiredDescription
ProjectIDpathintNo
MaterialShortfallsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ProjectIDformintNo
ShortfallsformList<MaterialShortfall>No
MaterialShortfall Parameters:
NameParameterData TypeRequiredDescription
MaterialIDformintNo
NameformstringNo
MaterialTypeformstringNo
OnHandformdecimalNo
QtyNeededformdecimalNo
ShortQtyformdecimalNo
UnitformstringNo
UnitPriceformdecimalNo
EstUSDformdecimalNo
VendorformstringNo
JobStartDateformDateTime?No

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

HTTP + OTHER

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