Trendsic Platform Service

<back to all web services

MaterialUsageRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/Material/{MaterialID}/usage

export class MaterialUsageEntry
{
    public Scope: string;
    public ProjectID: number;
    public ProjectName: string;
    public JobID: number;
    public JobName: string;
    public Quantity: number;
    public UsageDate: string;

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

export class MaterialUsageResponse
{
    public ResponseStatus: ResponseStatus;
    public Usage: MaterialUsageEntry[] = [];

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

export class MaterialUsageRequest
{
    public MaterialID: number;

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

TypeScript MaterialUsageRequest 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/Material/{MaterialID}/usage 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
		}
	},
	Usage: 
	[
		{
			Scope: String,
			ProjectID: 0,
			ProjectName: String,
			JobID: 0,
			JobName: String,
			Quantity: 0,
			UsageDate: String
		}
	]
}