Trendsic Platform Service

PmProjectDetailRequest

The following routes are available for this service:
GET,OPTIONS	/v1/pm/project/{Uid}

**PmProjectDetailRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Uid	path	string	No

**PmProjectDetail** Parameters:
Name	Parameter	Data Type	Required
ProjectID	form	int	No
ProjectUID	form	string	No
Name	form	string	No
Client	form	string	No
ProjectType	form	string	No
Status	form	string	No
Branch	form	string	No
StartDate	form	string	No
EndDate	form	string	No
Description	form	string	No
Finance	form	PmFinance	No
Readiness	form	PmReadiness	No
Jobs	form	List<PmJob>	No
Equipment	form	List<PmEquipmentRow>	No
Materials	form	List<PmMaterialRow>	No
Calendar	form	List<PmCalendarBar>	No
ProjectStatuses	form	List<PmCatalogItem>	No
ResponseStatus	form	ResponseStatus	No

**PmFinance** Parameters:
Name	Parameter	Data Type	Required
Budget	form	double	No
Spent	form	double	No
EstimatedCost	form	double	No
CrewCost	form	double	No
EquipCost	form	double	No
MatCost	form	double	No
Variance	form	double	No
HealthPct	form	int	No
SpentPct	form	int	No
ProgressPct	form	int	No

**PmReadiness** Parameters:
Name	Parameter	Data Type	Required
JobsNoCrew	form	int	No
OpenRoles	form	int	No
EquipmentConflicts	form	int	No
MaterialGaps	form	int	No
TotalGaps	form	int	No
ReadyPct	form	int	No

**PmJob** Parameters:
Name	Parameter	Data Type	Required
JobID	form	int	No
Name	form	string	No
Description	form	string	No
Status	form	string	No
StartDate	form	string	No
EndDate	form	string	No
CrewCount	form	int	No
BudgetedHours	form	double	No
EquipmentCount	form	int	No
MaterialCount	form	int	No
CrewCost	form	double	No
EquipCost	form	double	No
MatCost	form	double	No
Cost	form	double	No
NoCrew	form	bool	No
EquipConflict	form	bool	No
MaterialGap	form	bool	No
ReadyPct	form	int	No
Crew	form	List<PmJobCrew>	No
Equipment	form	List<PmJobResource>	No
Materials	form	List<PmJobResource>	No

**PmJobCrew** Parameters:
Name	Parameter	Data Type	Required
ContactID	form	int	No
Name	form	string	No
Rate	form	double	No
BudgetedHours	form	double	No
IsOpen	form	bool	No

**PmJobResource** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
Amount	form	double	No
Qty	form	int	No

**PmEquipmentRow** Parameters:
Name	Parameter	Data Type	Required
EquipmentID	form	int	No
Name	form	string	No
EquipmentType	form	string	No
SerialNumber	form	string	No
UsedByJobs	form	string	No
Available	form	bool	No
Conflicts	form	List<PmConflict>	No
MaintenanceIntervalDays	form	int?	No
LastServiceDate	form	string	No
NextServiceDate	form	string	No
MaintenanceState	form	string	No

**PmConflict** Parameters:
Name	Parameter	Data Type	Required
ProjectName	form	string	No
JobName	form	string	No
StartDate	form	string	No
EndDate	form	string	No

**PmMaterialRow** Parameters:
Name	Parameter	Data Type	Required
MaterialID	form	int	No
Name	form	string	No
MaterialType	form	string	No
OnHand	form	int	No
NeededByJobs	form	int	No
QtyNeeded	form	int	No
ToOrder	form	int	No
UnitCost	form	double	No
LineCost	form	double	No
ProjectMaterialID	form	int	No
StatusID	form	int	No
Status	form	string	No
Supplier	form	string	No
OrderDate	form	string	No
DeliveryDate	form	string	No
Shortfall	form	bool	No

**PmCalendarBar** Parameters:
Name	Parameter	Data Type	Required
JobID	form	int	No
Name	form	string	No
StartDate	form	string	No
EndDate	form	string	No
Status	form	string	No

**PmCatalogItem** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
Amount	form	double	No

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/pm/project/{Uid} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ProjectID: 0,
	ProjectUID: String,
	Name: String,
	Client: String,
	ProjectType: String,
	Status: String,
	Branch: String,
	StartDate: String,
	EndDate: String,
	Description: String,
	Finance: 
	{
		Budget: 0,
		Spent: 0,
		EstimatedCost: 0,
		CrewCost: 0,
		EquipCost: 0,
		MatCost: 0,
		Variance: 0,
		HealthPct: 0,
		SpentPct: 0,
		ProgressPct: 0
	},
	Readiness: 
	{
		JobsNoCrew: 0,
		OpenRoles: 0,
		EquipmentConflicts: 0,
		MaterialGaps: 0,
		TotalGaps: 0,
		ReadyPct: 0
	},
	Jobs: 
	[
		{
			JobID: 0,
			Name: String,
			Description: String,
			Status: String,
			StartDate: String,
			EndDate: String,
			CrewCount: 0,
			BudgetedHours: 0,
			EquipmentCount: 0,
			MaterialCount: 0,
			CrewCost: 0,
			EquipCost: 0,
			MatCost: 0,
			Cost: 0,
			NoCrew: False,
			EquipConflict: False,
			MaterialGap: False,
			ReadyPct: 0,
			Crew: 
			[
				{
					ContactID: 0,
					Name: String,
					Rate: 0,
					BudgetedHours: 0,
					IsOpen: False
				}
			],
			Equipment: 
			[
				{
					Id: 0,
					Name: String,
					Amount: 0,
					Qty: 0
				}
			],
			Materials: 
			[
				{
					Id: 0,
					Name: String,
					Amount: 0,
					Qty: 0
				}
			]
		}
	],
	Equipment: 
	[
		{
			EquipmentID: 0,
			Name: String,
			EquipmentType: String,
			SerialNumber: String,
			UsedByJobs: String,
			Available: False,
			Conflicts: 
			[
				{
					ProjectName: String,
					JobName: String,
					StartDate: String,
					EndDate: String
				}
			],
			MaintenanceIntervalDays: 0,
			LastServiceDate: String,
			NextServiceDate: String,
			MaintenanceState: String
		}
	],
	Materials: 
	[
		{
			MaterialID: 0,
			Name: String,
			MaterialType: String,
			OnHand: 0,
			NeededByJobs: 0,
			QtyNeeded: 0,
			ToOrder: 0,
			UnitCost: 0,
			LineCost: 0,
			ProjectMaterialID: 0,
			StatusID: 0,
			Status: String,
			Supplier: String,
			OrderDate: String,
			DeliveryDate: String,
			Shortfall: False
		}
	],
	Calendar: 
	[
		{
			JobID: 0,
			Name: String,
			StartDate: String,
			EndDate: String,
			Status: String
		}
	],
	ProjectStatuses: 
	[
		{
			Id: 0,
			Name: String,
			Amount: 0
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}