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