| GET,OPTIONS | /v1/pm/resources |
|---|
"use strict";
export class PmResCommitment {
/** @param {{ProjectName?:string,JobName?:string,StartDate?:string,EndDate?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ProjectName;
/** @type {string} */
JobName;
/** @type {string} */
StartDate;
/** @type {string} */
EndDate;
}
export class PmResEquipment {
/** @param {{EquipmentID?:number,Name?:string,EquipmentType?:string,SerialNumber?:string,JobCount?:number,Overbooked?:boolean,MaintenanceState?:string,Commitments?:PmResCommitment[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
EquipmentID;
/** @type {string} */
Name;
/** @type {string} */
EquipmentType;
/** @type {string} */
SerialNumber;
/** @type {number} */
JobCount;
/** @type {boolean} */
Overbooked;
/** @type {string} */
MaintenanceState;
/** @type {PmResCommitment[]} */
Commitments = [];
}
export class PmResMaterial {
/** @param {{MaterialID?:number,Name?:string,MaterialType?:string,OnHand?:number,NeededByJobs?:number,QtyNeeded?:number,Shortfall?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
MaterialID;
/** @type {string} */
Name;
/** @type {string} */
MaterialType;
/** @type {number} */
OnHand;
/** @type {number} */
NeededByJobs;
/** @type {number} */
QtyNeeded;
/** @type {boolean} */
Shortfall;
}
export class PmResourcesResponse {
/** @param {{FromDate?:string,ToDate?:string,OverbookedCount?:number,CommittedCount?:number,ShortfallCount?:number,Equipment?:PmResEquipment[],Materials?:PmResMaterial[],ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
FromDate;
/** @type {string} */
ToDate;
/** @type {number} */
OverbookedCount;
/** @type {number} */
CommittedCount;
/** @type {number} */
ShortfallCount;
/** @type {PmResEquipment[]} */
Equipment = [];
/** @type {PmResMaterial[]} */
Materials = [];
/** @type {ResponseStatus} */
ResponseStatus;
}
export class PmResourcesRequest {
/** @param {{Days?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Days;
}
JavaScript PmResourcesRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<PmResourcesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<CommittedCount>0</CommittedCount>
<Equipment>
<PmResEquipment>
<Commitments>
<PmResCommitment>
<EndDate>String</EndDate>
<JobName>String</JobName>
<ProjectName>String</ProjectName>
<StartDate>String</StartDate>
</PmResCommitment>
</Commitments>
<EquipmentID>0</EquipmentID>
<EquipmentType>String</EquipmentType>
<JobCount>0</JobCount>
<MaintenanceState>String</MaintenanceState>
<Name>String</Name>
<Overbooked>false</Overbooked>
<SerialNumber>String</SerialNumber>
</PmResEquipment>
</Equipment>
<FromDate>String</FromDate>
<Materials>
<PmResMaterial>
<MaterialID>0</MaterialID>
<MaterialType>String</MaterialType>
<Name>String</Name>
<NeededByJobs>0</NeededByJobs>
<OnHand>0</OnHand>
<QtyNeeded>0</QtyNeeded>
<Shortfall>false</Shortfall>
</PmResMaterial>
</Materials>
<OverbookedCount>0</OverbookedCount>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<ShortfallCount>0</ShortfallCount>
<ToDate>String</ToDate>
</PmResourcesResponse>