Trendsic Platform Service

<back to all web services

PmProjectDetailRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/pm/project/{Uid}
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type PmFinance() = 
        member val Budget:Double = new Double() with get,set
        member val Spent:Double = new Double() with get,set
        member val EstimatedCost:Double = new Double() with get,set
        member val CrewCost:Double = new Double() with get,set
        member val EquipCost:Double = new Double() with get,set
        member val MatCost:Double = new Double() with get,set
        member val Variance:Double = new Double() with get,set
        member val HealthPct:Int32 = new Int32() with get,set
        member val SpentPct:Int32 = new Int32() with get,set
        member val ProgressPct:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type PmReadiness() = 
        member val JobsNoCrew:Int32 = new Int32() with get,set
        member val OpenRoles:Int32 = new Int32() with get,set
        member val EquipmentConflicts:Int32 = new Int32() with get,set
        member val MaterialGaps:Int32 = new Int32() with get,set
        member val TotalGaps:Int32 = new Int32() with get,set
        member val ReadyPct:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type PmJobCrew() = 
        member val ContactID:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val Rate:Double = new Double() with get,set
        member val BudgetedHours:Double = new Double() with get,set
        member val IsOpen:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type PmJobResource() = 
        member val Id:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val Amount:Double = new Double() with get,set
        member val Qty:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type PmJob() = 
        member val JobID:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val Status:String = null with get,set
        member val StartDate:String = null with get,set
        member val EndDate:String = null with get,set
        member val CrewCount:Int32 = new Int32() with get,set
        member val BudgetedHours:Double = new Double() with get,set
        member val EquipmentCount:Int32 = new Int32() with get,set
        member val MaterialCount:Int32 = new Int32() with get,set
        member val CrewCost:Double = new Double() with get,set
        member val EquipCost:Double = new Double() with get,set
        member val MatCost:Double = new Double() with get,set
        member val Cost:Double = new Double() with get,set
        member val NoCrew:Boolean = new Boolean() with get,set
        member val EquipConflict:Boolean = new Boolean() with get,set
        member val MaterialGap:Boolean = new Boolean() with get,set
        member val ReadyPct:Int32 = new Int32() with get,set
        member val Crew:ResizeArray<PmJobCrew> = new ResizeArray<PmJobCrew>() with get,set
        member val Equipment:ResizeArray<PmJobResource> = new ResizeArray<PmJobResource>() with get,set
        member val Materials:ResizeArray<PmJobResource> = new ResizeArray<PmJobResource>() with get,set

    [<AllowNullLiteral>]
    type PmConflict() = 
        member val ProjectName:String = null with get,set
        member val JobName:String = null with get,set
        member val StartDate:String = null with get,set
        member val EndDate:String = null with get,set

    [<AllowNullLiteral>]
    type PmEquipmentRow() = 
        member val EquipmentID:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val EquipmentType:String = null with get,set
        member val SerialNumber:String = null with get,set
        member val UsedByJobs:String = null with get,set
        member val Available:Boolean = new Boolean() with get,set
        member val Conflicts:ResizeArray<PmConflict> = new ResizeArray<PmConflict>() with get,set
        member val MaintenanceIntervalDays:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val LastServiceDate:String = null with get,set
        member val NextServiceDate:String = null with get,set
        member val MaintenanceState:String = null with get,set

    [<AllowNullLiteral>]
    type PmMaterialRow() = 
        member val MaterialID:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val MaterialType:String = null with get,set
        member val OnHand:Int32 = new Int32() with get,set
        member val NeededByJobs:Int32 = new Int32() with get,set
        member val QtyNeeded:Int32 = new Int32() with get,set
        member val ToOrder:Int32 = new Int32() with get,set
        member val UnitCost:Double = new Double() with get,set
        member val LineCost:Double = new Double() with get,set
        member val ProjectMaterialID:Int32 = new Int32() with get,set
        member val StatusID:Int32 = new Int32() with get,set
        member val Status:String = null with get,set
        member val Supplier:String = null with get,set
        member val OrderDate:String = null with get,set
        member val DeliveryDate:String = null with get,set
        member val Shortfall:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type PmCalendarBar() = 
        member val JobID:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val StartDate:String = null with get,set
        member val EndDate:String = null with get,set
        member val Status:String = null with get,set

    [<AllowNullLiteral>]
    type PmCatalogItem() = 
        member val Id:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val Amount:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type PmProjectDetail() = 
        member val ProjectID:Int32 = new Int32() with get,set
        member val ProjectUID:String = null with get,set
        member val Name:String = null with get,set
        member val Client:String = null with get,set
        member val ProjectType:String = null with get,set
        member val Status:String = null with get,set
        member val Branch:String = null with get,set
        member val StartDate:String = null with get,set
        member val EndDate:String = null with get,set
        member val Description:String = null with get,set
        member val Finance:PmFinance = null with get,set
        member val Readiness:PmReadiness = null with get,set
        member val Jobs:ResizeArray<PmJob> = new ResizeArray<PmJob>() with get,set
        member val Equipment:ResizeArray<PmEquipmentRow> = new ResizeArray<PmEquipmentRow>() with get,set
        member val Materials:ResizeArray<PmMaterialRow> = new ResizeArray<PmMaterialRow>() with get,set
        member val Calendar:ResizeArray<PmCalendarBar> = new ResizeArray<PmCalendarBar>() with get,set
        member val ProjectStatuses:ResizeArray<PmCatalogItem> = new ResizeArray<PmCatalogItem>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type PmProjectDetailRequest() = 
        member val Uid:String = null with get,set

F# PmProjectDetailRequest DTOs

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