Trendsic Platform Service

PmProjectDetailRequest

The following routes are available for this service:
GET,OPTIONS	/v1/pm/project/{Uid}

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PmFinance:
    budget: float = 0.0
    spent: float = 0.0
    estimated_cost: float = 0.0
    crew_cost: float = 0.0
    equip_cost: float = 0.0
    mat_cost: float = 0.0
    variance: float = 0.0
    health_pct: int = 0
    spent_pct: int = 0
    progress_pct: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PmReadiness:
    jobs_no_crew: int = 0
    open_roles: int = 0
    equipment_conflicts: int = 0
    material_gaps: int = 0
    total_gaps: int = 0
    ready_pct: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PmJobCrew:
    contact_i_d: int = 0
    name: Optional[str] = None
    rate: float = 0.0
    budgeted_hours: float = 0.0
    is_open: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PmJobResource:
    id: int = 0
    name: Optional[str] = None
    amount: float = 0.0
    qty: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PmJob:
    job_i_d: int = 0
    name: Optional[str] = None
    description: Optional[str] = None
    status: Optional[str] = None
    start_date: Optional[str] = None
    end_date: Optional[str] = None
    crew_count: int = 0
    budgeted_hours: float = 0.0
    equipment_count: int = 0
    material_count: int = 0
    crew_cost: float = 0.0
    equip_cost: float = 0.0
    mat_cost: float = 0.0
    cost: float = 0.0
    no_crew: bool = False
    equip_conflict: bool = False
    material_gap: bool = False
    ready_pct: int = 0
    crew: List[PmJobCrew] = field(default_factory=list)
    equipment: List[PmJobResource] = field(default_factory=list)
    materials: List[PmJobResource] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PmConflict:
    project_name: Optional[str] = None
    job_name: Optional[str] = None
    start_date: Optional[str] = None
    end_date: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PmEquipmentRow:
    equipment_i_d: int = 0
    name: Optional[str] = None
    equipment_type: Optional[str] = None
    serial_number: Optional[str] = None
    used_by_jobs: Optional[str] = None
    available: bool = False
    conflicts: List[PmConflict] = field(default_factory=list)
    maintenance_interval_days: Optional[int] = None
    last_service_date: Optional[str] = None
    next_service_date: Optional[str] = None
    maintenance_state: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PmMaterialRow:
    material_i_d: int = 0
    name: Optional[str] = None
    material_type: Optional[str] = None
    on_hand: int = 0
    needed_by_jobs: int = 0
    qty_needed: int = 0
    to_order: int = 0
    unit_cost: float = 0.0
    line_cost: float = 0.0
    project_material_i_d: int = 0
    status_i_d: int = 0
    status: Optional[str] = None
    supplier: Optional[str] = None
    order_date: Optional[str] = None
    delivery_date: Optional[str] = None
    shortfall: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PmCalendarBar:
    job_i_d: int = 0
    name: Optional[str] = None
    start_date: Optional[str] = None
    end_date: Optional[str] = None
    status: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PmCatalogItem:
    id: int = 0
    name: Optional[str] = None
    amount: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PmProjectDetail:
    project_i_d: int = 0
    project_u_i_d: Optional[str] = None
    name: Optional[str] = None
    client: Optional[str] = None
    project_type: Optional[str] = None
    status: Optional[str] = None
    branch: Optional[str] = None
    start_date: Optional[str] = None
    end_date: Optional[str] = None
    description: Optional[str] = None
    finance: Optional[PmFinance] = None
    readiness: Optional[PmReadiness] = None
    jobs: List[PmJob] = field(default_factory=list)
    equipment: List[PmEquipmentRow] = field(default_factory=list)
    materials: List[PmMaterialRow] = field(default_factory=list)
    calendar: List[PmCalendarBar] = field(default_factory=list)
    project_statuses: List[PmCatalogItem] = field(default_factory=list)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PmProjectDetailRequest:
    uid: Optional[str] = None

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