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 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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ProjectID":0,"ProjectUID":"String","Name":"String","Client":"String","ProjectType":"String","Status":"String","Branch":"String","StartDate":"String","EndDate":"String","Description":"String","Finance":{"Budget":0,"Spent":0,"EstimatedCost":0,"CrewCost":0,"EquipCost":0,"MatCost":0,"Variance":0,"HealthPct":0,"SpentPct":0,"ProgressPct":0},"Readiness":{"JobsNoCrew":0,"OpenRoles":0,"EquipmentConflicts":0,"MaterialGaps":0,"TotalGaps":0,"ReadyPct":0},"Jobs":[{"JobID":0,"Name":"String","Description":"String","Status":"String","StartDate":"String","EndDate":"String","CrewCount":0,"BudgetedHours":0,"EquipmentCount":0,"MaterialCount":0,"CrewCost":0,"EquipCost":0,"MatCost":0,"Cost":0,"NoCrew":false,"EquipConflict":false,"MaterialGap":false,"ReadyPct":0,"Crew":[{"ContactID":0,"Name":"String","Rate":0,"BudgetedHours":0,"IsOpen":false}],"Equipment":[{"Id":0,"Name":"String","Amount":0,"Qty":0}],"Materials":[{"Id":0,"Name":"String","Amount":0,"Qty":0}]}],"Equipment":[{"EquipmentID":0,"Name":"String","EquipmentType":"String","SerialNumber":"String","UsedByJobs":"String","Available":false,"Conflicts":[{"ProjectName":"String","JobName":"String","StartDate":"String","EndDate":"String"}],"MaintenanceIntervalDays":0,"LastServiceDate":"String","NextServiceDate":"String","MaintenanceState":"String"}],"Materials":[{"MaterialID":0,"Name":"String","MaterialType":"String","OnHand":0,"NeededByJobs":0,"QtyNeeded":0,"ToOrder":0,"UnitCost":0,"LineCost":0,"ProjectMaterialID":0,"StatusID":0,"Status":"String","Supplier":"String","OrderDate":"String","DeliveryDate":"String","Shortfall":false}],"Calendar":[{"JobID":0,"Name":"String","StartDate":"String","EndDate":"String","Status":"String"}],"ProjectStatuses":[{"Id":0,"Name":"String","Amount":0}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}