Trendsic Platform Service

<back to all web services

PmResourcesRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/pm/resources
PmResourcesRequest Parameters:
NameParameterData TypeRequiredDescription
DaysqueryintNo
PmResourcesResponse Parameters:
NameParameterData TypeRequiredDescription
FromDateformstringNo
ToDateformstringNo
OverbookedCountformintNo
CommittedCountformintNo
ShortfallCountformintNo
EquipmentformList<PmResEquipment>No
MaterialsformList<PmResMaterial>No
ResponseStatusformResponseStatusNo
PmResEquipment Parameters:
NameParameterData TypeRequiredDescription
EquipmentIDformintNo
NameformstringNo
EquipmentTypeformstringNo
SerialNumberformstringNo
JobCountformintNo
OverbookedformboolNo
MaintenanceStateformstringNo
CommitmentsformList<PmResCommitment>No
PmResCommitment Parameters:
NameParameterData TypeRequiredDescription
ProjectNameformstringNo
JobNameformstringNo
StartDateformstringNo
EndDateformstringNo
PmResMaterial Parameters:
NameParameterData TypeRequiredDescription
MaterialIDformintNo
NameformstringNo
MaterialTypeformstringNo
OnHandformintNo
NeededByJobsformintNo
QtyNeededformintNo
ShortfallformboolNo

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"}}}