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}

export class PmFinance
{
    public Budget: number;
    public Spent: number;
    public EstimatedCost: number;
    public CrewCost: number;
    public EquipCost: number;
    public MatCost: number;
    public Variance: number;
    public HealthPct: number;
    public SpentPct: number;
    public ProgressPct: number;

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

export class PmReadiness
{
    public JobsNoCrew: number;
    public OpenRoles: number;
    public EquipmentConflicts: number;
    public MaterialGaps: number;
    public TotalGaps: number;
    public ReadyPct: number;

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

export class PmJobCrew
{
    public ContactID: number;
    public Name: string;
    public Rate: number;
    public BudgetedHours: number;
    public IsOpen: boolean;

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

export class PmJobResource
{
    public Id: number;
    public Name: string;
    public Amount: number;
    public Qty: number;

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

export class PmJob
{
    public JobID: number;
    public Name: string;
    public Description: string;
    public Status: string;
    public StartDate: string;
    public EndDate: string;
    public CrewCount: number;
    public BudgetedHours: number;
    public EquipmentCount: number;
    public MaterialCount: number;
    public CrewCost: number;
    public EquipCost: number;
    public MatCost: number;
    public Cost: number;
    public NoCrew: boolean;
    public EquipConflict: boolean;
    public MaterialGap: boolean;
    public ReadyPct: number;
    public Crew: PmJobCrew[] = [];
    public Equipment: PmJobResource[] = [];
    public Materials: PmJobResource[] = [];

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

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

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

export class PmEquipmentRow
{
    public EquipmentID: number;
    public Name: string;
    public EquipmentType: string;
    public SerialNumber: string;
    public UsedByJobs: string;
    public Available: boolean;
    public Conflicts: PmConflict[] = [];
    public MaintenanceIntervalDays?: number;
    public LastServiceDate: string;
    public NextServiceDate: string;
    public MaintenanceState: string;

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

export class PmMaterialRow
{
    public MaterialID: number;
    public Name: string;
    public MaterialType: string;
    public OnHand: number;
    public NeededByJobs: number;
    public QtyNeeded: number;
    public ToOrder: number;
    public UnitCost: number;
    public LineCost: number;
    public ProjectMaterialID: number;
    public StatusID: number;
    public Status: string;
    public Supplier: string;
    public OrderDate: string;
    public DeliveryDate: string;
    public Shortfall: boolean;

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

export class PmCalendarBar
{
    public JobID: number;
    public Name: string;
    public StartDate: string;
    public EndDate: string;
    public Status: string;

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

export class PmCatalogItem
{
    public Id: number;
    public Name: string;
    public Amount: number;

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

export class PmProjectDetail
{
    public ProjectID: number;
    public ProjectUID: string;
    public Name: string;
    public Client: string;
    public ProjectType: string;
    public Status: string;
    public Branch: string;
    public StartDate: string;
    public EndDate: string;
    public Description: string;
    public Finance: PmFinance;
    public Readiness: PmReadiness;
    public Jobs: PmJob[] = [];
    public Equipment: PmEquipmentRow[] = [];
    public Materials: PmMaterialRow[] = [];
    public Calendar: PmCalendarBar[] = [];
    public ProjectStatuses: PmCatalogItem[] = [];
    public ResponseStatus: ResponseStatus;

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

export class PmProjectDetailRequest
{
    public Uid: string;

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

TypeScript PmProjectDetailRequest DTOs

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

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PmProjectDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Branch>String</Branch>
  <Calendar>
    <PmCalendarBar>
      <EndDate>String</EndDate>
      <JobID>0</JobID>
      <Name>String</Name>
      <StartDate>String</StartDate>
      <Status>String</Status>
    </PmCalendarBar>
  </Calendar>
  <Client>String</Client>
  <Description>String</Description>
  <EndDate>String</EndDate>
  <Equipment>
    <PmEquipmentRow>
      <Available>false</Available>
      <Conflicts>
        <PmConflict>
          <EndDate>String</EndDate>
          <JobName>String</JobName>
          <ProjectName>String</ProjectName>
          <StartDate>String</StartDate>
        </PmConflict>
      </Conflicts>
      <EquipmentID>0</EquipmentID>
      <EquipmentType>String</EquipmentType>
      <LastServiceDate>String</LastServiceDate>
      <MaintenanceIntervalDays>0</MaintenanceIntervalDays>
      <MaintenanceState>String</MaintenanceState>
      <Name>String</Name>
      <NextServiceDate>String</NextServiceDate>
      <SerialNumber>String</SerialNumber>
      <UsedByJobs>String</UsedByJobs>
    </PmEquipmentRow>
  </Equipment>
  <Finance>
    <Budget>0</Budget>
    <CrewCost>0</CrewCost>
    <EquipCost>0</EquipCost>
    <EstimatedCost>0</EstimatedCost>
    <HealthPct>0</HealthPct>
    <MatCost>0</MatCost>
    <ProgressPct>0</ProgressPct>
    <Spent>0</Spent>
    <SpentPct>0</SpentPct>
    <Variance>0</Variance>
  </Finance>
  <Jobs>
    <PmJob>
      <BudgetedHours>0</BudgetedHours>
      <Cost>0</Cost>
      <Crew>
        <PmJobCrew>
          <BudgetedHours>0</BudgetedHours>
          <ContactID>0</ContactID>
          <IsOpen>false</IsOpen>
          <Name>String</Name>
          <Rate>0</Rate>
        </PmJobCrew>
      </Crew>
      <CrewCost>0</CrewCost>
      <CrewCount>0</CrewCount>
      <Description>String</Description>
      <EndDate>String</EndDate>
      <EquipConflict>false</EquipConflict>
      <EquipCost>0</EquipCost>
      <Equipment>
        <PmJobResource>
          <Amount>0</Amount>
          <Id>0</Id>
          <Name>String</Name>
          <Qty>0</Qty>
        </PmJobResource>
      </Equipment>
      <EquipmentCount>0</EquipmentCount>
      <JobID>0</JobID>
      <MatCost>0</MatCost>
      <MaterialCount>0</MaterialCount>
      <MaterialGap>false</MaterialGap>
      <Materials>
        <PmJobResource>
          <Amount>0</Amount>
          <Id>0</Id>
          <Name>String</Name>
          <Qty>0</Qty>
        </PmJobResource>
      </Materials>
      <Name>String</Name>
      <NoCrew>false</NoCrew>
      <ReadyPct>0</ReadyPct>
      <StartDate>String</StartDate>
      <Status>String</Status>
    </PmJob>
  </Jobs>
  <Materials>
    <PmMaterialRow>
      <DeliveryDate>String</DeliveryDate>
      <LineCost>0</LineCost>
      <MaterialID>0</MaterialID>
      <MaterialType>String</MaterialType>
      <Name>String</Name>
      <NeededByJobs>0</NeededByJobs>
      <OnHand>0</OnHand>
      <OrderDate>String</OrderDate>
      <ProjectMaterialID>0</ProjectMaterialID>
      <QtyNeeded>0</QtyNeeded>
      <Shortfall>false</Shortfall>
      <Status>String</Status>
      <StatusID>0</StatusID>
      <Supplier>String</Supplier>
      <ToOrder>0</ToOrder>
      <UnitCost>0</UnitCost>
    </PmMaterialRow>
  </Materials>
  <Name>String</Name>
  <ProjectID>0</ProjectID>
  <ProjectStatuses>
    <PmCatalogItem>
      <Amount>0</Amount>
      <Id>0</Id>
      <Name>String</Name>
    </PmCatalogItem>
  </ProjectStatuses>
  <ProjectType>String</ProjectType>
  <ProjectUID>String</ProjectUID>
  <Readiness>
    <EquipmentConflicts>0</EquipmentConflicts>
    <JobsNoCrew>0</JobsNoCrew>
    <MaterialGaps>0</MaterialGaps>
    <OpenRoles>0</OpenRoles>
    <ReadyPct>0</ReadyPct>
    <TotalGaps>0</TotalGaps>
  </Readiness>
  <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>
  <StartDate>String</StartDate>
  <Status>String</Status>
</PmProjectDetail>