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}
import Foundation
import ServiceStack

public class PmProjectDetailRequest : Codable
{
    public var uid:String

    required public init(){}
}

public class PmProjectDetail : Codable
{
    public var projectID:Int
    public var projectUID:String
    public var name:String
    public var client:String
    public var projectType:String
    public var status:String
    public var branch:String
    public var startDate:String
    public var endDate:String
    public var Description:String
    public var finance:PmFinance
    public var readiness:PmReadiness
    public var jobs:[PmJob] = []
    public var equipment:[PmEquipmentRow] = []
    public var materials:[PmMaterialRow] = []
    public var calendar:[PmCalendarBar] = []
    public var projectStatuses:[PmCatalogItem] = []
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class PmFinance : Codable
{
    public var budget:Double
    public var spent:Double
    public var estimatedCost:Double
    public var crewCost:Double
    public var equipCost:Double
    public var matCost:Double
    public var variance:Double
    public var healthPct:Int
    public var spentPct:Int
    public var progressPct:Int

    required public init(){}
}

public class PmReadiness : Codable
{
    public var jobsNoCrew:Int
    public var openRoles:Int
    public var equipmentConflicts:Int
    public var materialGaps:Int
    public var totalGaps:Int
    public var readyPct:Int

    required public init(){}
}

public class PmJob : Codable
{
    public var jobID:Int
    public var name:String
    public var Description:String
    public var status:String
    public var startDate:String
    public var endDate:String
    public var crewCount:Int
    public var budgetedHours:Double
    public var equipmentCount:Int
    public var materialCount:Int
    public var crewCost:Double
    public var equipCost:Double
    public var matCost:Double
    public var cost:Double
    public var noCrew:Bool
    public var equipConflict:Bool
    public var materialGap:Bool
    public var readyPct:Int
    public var crew:[PmJobCrew] = []
    public var equipment:[PmJobResource] = []
    public var materials:[PmJobResource] = []

    required public init(){}
}

public class PmJobCrew : Codable
{
    public var contactID:Int
    public var name:String
    public var rate:Double
    public var budgetedHours:Double
    public var isOpen:Bool

    required public init(){}
}

public class PmJobResource : Codable
{
    public var id:Int
    public var name:String
    public var amount:Double
    public var qty:Int

    required public init(){}
}

public class PmEquipmentRow : Codable
{
    public var equipmentID:Int
    public var name:String
    public var equipmentType:String
    public var serialNumber:String
    public var usedByJobs:String
    public var available:Bool
    public var conflicts:[PmConflict] = []
    public var maintenanceIntervalDays:Int?
    public var lastServiceDate:String
    public var nextServiceDate:String
    public var maintenanceState:String

    required public init(){}
}

public class PmConflict : Codable
{
    public var projectName:String
    public var jobName:String
    public var startDate:String
    public var endDate:String

    required public init(){}
}

public class PmMaterialRow : Codable
{
    public var materialID:Int
    public var name:String
    public var materialType:String
    public var onHand:Int
    public var neededByJobs:Int
    public var qtyNeeded:Int
    public var toOrder:Int
    public var unitCost:Double
    public var lineCost:Double
    public var projectMaterialID:Int
    public var statusID:Int
    public var status:String
    public var supplier:String
    public var orderDate:String
    public var deliveryDate:String
    public var shortfall:Bool

    required public init(){}
}

public class PmCalendarBar : Codable
{
    public var jobID:Int
    public var name:String
    public var startDate:String
    public var endDate:String
    public var status:String

    required public init(){}
}

public class PmCatalogItem : Codable
{
    public var id:Int
    public var name:String
    public var amount:Double

    required public init(){}
}


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