Trendsic Platform Service

<back to all web services

PmResourcesRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/pm/resources

export class PmResCommitment
{
    public ProjectName: string;
    public JobName: string;
    public StartDate: string;
    public EndDate: string;

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

export class PmResEquipment
{
    public EquipmentID: number;
    public Name: string;
    public EquipmentType: string;
    public SerialNumber: string;
    public JobCount: number;
    public Overbooked: boolean;
    public MaintenanceState: string;
    public Commitments: PmResCommitment[] = [];

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

export class PmResMaterial
{
    public MaterialID: number;
    public Name: string;
    public MaterialType: string;
    public OnHand: number;
    public NeededByJobs: number;
    public QtyNeeded: number;
    public Shortfall: boolean;

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

export class PmResourcesResponse
{
    public FromDate: string;
    public ToDate: string;
    public OverbookedCount: number;
    public CommittedCount: number;
    public ShortfallCount: number;
    public Equipment: PmResEquipment[] = [];
    public Materials: PmResMaterial[] = [];
    public ResponseStatus: ResponseStatus;

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

export class PmResourcesRequest
{
    public Days: number;

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

TypeScript PmResourcesRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/pm/resources HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"FromDate":"String","ToDate":"String","OverbookedCount":0,"CommittedCount":0,"ShortfallCount":0,"Equipment":[{"EquipmentID":0,"Name":"String","EquipmentType":"String","SerialNumber":"String","JobCount":0,"Overbooked":false,"MaintenanceState":"String","Commitments":[{"ProjectName":"String","JobName":"String","StartDate":"String","EndDate":"String"}]}],"Materials":[{"MaterialID":0,"Name":"String","MaterialType":"String","OnHand":0,"NeededByJobs":0,"QtyNeeded":0,"Shortfall":false}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}