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
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type MaterialShortfall() = 
        member val MaterialID:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val MaterialType:String = null with get,set
        member val OnHand:Decimal = new Decimal() with get,set
        member val QtyNeeded:Decimal = new Decimal() with get,set
        member val ShortQty:Decimal = new Decimal() with get,set
        member val Unit:String = null with get,set
        member val UnitPrice:Decimal = new Decimal() with get,set
        member val EstUSD:Decimal = new Decimal() with get,set
        member val Vendor:String = null with get,set
        member val JobStartDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type MaterialShortfallsResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val ProjectID:Int32 = new Int32() with get,set
        member val Shortfalls:ResizeArray<MaterialShortfall> = new ResizeArray<MaterialShortfall>() with get,set

    [<AllowNullLiteral>]
    type MaterialShortfallsRequest() = 
        member val ProjectID:Int32 = new Int32() with get,set

F# 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
		}
	]
}