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
"use strict";
export class EquipmentUsageEntry {
    /** @param {{ProjectJobEquipmentID?:number,ProjectID?:number,ProjectName?:string,JobID?:number,JobName?:string,StatusID?:number,StartDate?:string,EndDate?:string,BookingCount?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectJobEquipmentID;
    /** @type {number} */
    ProjectID;
    /** @type {string} */
    ProjectName;
    /** @type {number} */
    JobID;
    /** @type {string} */
    JobName;
    /** @type {?number} */
    StatusID;
    /** @type {?string} */
    StartDate;
    /** @type {?string} */
    EndDate;
    /** @type {number} */
    BookingCount;
}
export class VehicleDriverUse {
    /** @param {{SessionId?:number,ContactID?:number,Name?:string,Board?:string,StartUtc?:string,EndUtc?:string,EndReason?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    SessionId;
    /** @type {number} */
    ContactID;
    /** @type {string} */
    Name;
    /** @type {string} */
    Board;
    /** @type {string} */
    StartUtc;
    /** @type {?string} */
    EndUtc;
    /** @type {string} */
    EndReason;
}
export class EquipmentUsageResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Usage?:EquipmentUsageEntry[],Drivers?:VehicleDriverUse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {EquipmentUsageEntry[]} */
    Usage = [];
    /** @type {VehicleDriverUse[]} */
    Drivers = [];
}
export class EquipmentUsageRequest {
    /** @param {{EquipmentID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    EquipmentID;
}

JavaScript EquipmentUsageRequest DTOs

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/Equipment/{EquipmentID}/usage 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"}},"Usage":[{"ProjectJobEquipmentID":0,"ProjectID":0,"ProjectName":"String","JobID":0,"JobName":"String","StatusID":0,"StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","BookingCount":0}],"Drivers":[{"SessionId":0,"ContactID":0,"Name":"String","Board":"String","StartUtc":"0001-01-01T00:00:00.0000000","EndUtc":"0001-01-01T00:00:00.0000000","EndReason":"String"}]}