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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class PmProjectDetailRequest
{
    open var Uid:String? = null
}

open class PmProjectDetail
{
    open var ProjectID:Int? = null
    open var ProjectUID:String? = null
    open var Name:String? = null
    open var Client:String? = null
    open var ProjectType:String? = null
    open var Status:String? = null
    open var Branch:String? = null
    open var StartDate:String? = null
    open var EndDate:String? = null
    open var Description:String? = null
    open var Finance:PmFinance? = null
    open var Readiness:PmReadiness? = null
    open var Jobs:ArrayList<PmJob> = ArrayList<PmJob>()
    open var Equipment:ArrayList<PmEquipmentRow> = ArrayList<PmEquipmentRow>()
    open var Materials:ArrayList<PmMaterialRow> = ArrayList<PmMaterialRow>()
    open var Calendar:ArrayList<PmCalendarBar> = ArrayList<PmCalendarBar>()
    open var ProjectStatuses:ArrayList<PmCatalogItem> = ArrayList<PmCatalogItem>()
    open var ResponseStatus:ResponseStatus? = null
}

open class PmFinance
{
    open var Budget:Double? = null
    open var Spent:Double? = null
    open var EstimatedCost:Double? = null
    open var CrewCost:Double? = null
    open var EquipCost:Double? = null
    open var MatCost:Double? = null
    open var Variance:Double? = null
    open var HealthPct:Int? = null
    open var SpentPct:Int? = null
    open var ProgressPct:Int? = null
}

open class PmReadiness
{
    open var JobsNoCrew:Int? = null
    open var OpenRoles:Int? = null
    open var EquipmentConflicts:Int? = null
    open var MaterialGaps:Int? = null
    open var TotalGaps:Int? = null
    open var ReadyPct:Int? = null
}

open class PmJob
{
    open var JobID:Int? = null
    open var Name:String? = null
    open var Description:String? = null
    open var Status:String? = null
    open var StartDate:String? = null
    open var EndDate:String? = null
    open var CrewCount:Int? = null
    open var BudgetedHours:Double? = null
    open var EquipmentCount:Int? = null
    open var MaterialCount:Int? = null
    open var CrewCost:Double? = null
    open var EquipCost:Double? = null
    open var MatCost:Double? = null
    open var Cost:Double? = null
    open var NoCrew:Boolean? = null
    open var EquipConflict:Boolean? = null
    open var MaterialGap:Boolean? = null
    open var ReadyPct:Int? = null
    open var Crew:ArrayList<PmJobCrew> = ArrayList<PmJobCrew>()
    open var Equipment:ArrayList<PmJobResource> = ArrayList<PmJobResource>()
    open var Materials:ArrayList<PmJobResource> = ArrayList<PmJobResource>()
}

open class PmJobCrew
{
    open var ContactID:Int? = null
    open var Name:String? = null
    open var Rate:Double? = null
    open var BudgetedHours:Double? = null
    open var IsOpen:Boolean? = null
}

open class PmJobResource
{
    open var Id:Int? = null
    open var Name:String? = null
    open var Amount:Double? = null
    open var Qty:Int? = null
}

open class PmEquipmentRow
{
    open var EquipmentID:Int? = null
    open var Name:String? = null
    open var EquipmentType:String? = null
    open var SerialNumber:String? = null
    open var UsedByJobs:String? = null
    open var Available:Boolean? = null
    open var Conflicts:ArrayList<PmConflict> = ArrayList<PmConflict>()
    open var MaintenanceIntervalDays:Int? = null
    open var LastServiceDate:String? = null
    open var NextServiceDate:String? = null
    open var MaintenanceState:String? = null
}

open class PmConflict
{
    open var ProjectName:String? = null
    open var JobName:String? = null
    open var StartDate:String? = null
    open var EndDate:String? = null
}

open class PmMaterialRow
{
    open var MaterialID:Int? = null
    open var Name:String? = null
    open var MaterialType:String? = null
    open var OnHand:Int? = null
    open var NeededByJobs:Int? = null
    open var QtyNeeded:Int? = null
    open var ToOrder:Int? = null
    open var UnitCost:Double? = null
    open var LineCost:Double? = null
    open var ProjectMaterialID:Int? = null
    open var StatusID:Int? = null
    open var Status:String? = null
    open var Supplier:String? = null
    open var OrderDate:String? = null
    open var DeliveryDate:String? = null
    open var Shortfall:Boolean? = null
}

open class PmCalendarBar
{
    open var JobID:Int? = null
    open var Name:String? = null
    open var StartDate:String? = null
    open var EndDate:String? = null
    open var Status:String? = null
}

open class PmCatalogItem
{
    open var Id:Int? = null
    open var Name:String? = null
    open var Amount:Double? = null
}

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