Trendsic Platform Service

<back to all web services

EquipmentUsageRequest

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

export class EquipmentUsageEntry
{
    public ProjectJobEquipmentID: number;
    public ProjectID: number;
    public ProjectName: string;
    public JobID: number;
    public JobName: string;
    public StatusID?: number;
    public StartDate?: string;
    public EndDate?: string;
    public BookingCount: number;

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

export class EquipmentUsageResponse
{
    public ResponseStatus: ResponseStatus;
    public Usage: EquipmentUsageEntry[] = [];

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

export class EquipmentUsageRequest
{
    public EquipmentID: number;

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

TypeScript EquipmentUsageRequest 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/Equipment/{EquipmentID}/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: 
	[
		{
			ProjectJobEquipmentID: 0,
			ProjectID: 0,
			ProjectName: String,
			JobID: 0,
			JobName: String,
			StatusID: 0,
			StartDate: 0001-01-01,
			EndDate: 0001-01-01,
			BookingCount: 0
		}
	]
}