Trendsic Platform Service

ProjectTimelineRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator

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

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 TimelineCrew:
    project_job_crew_member_i_d: int = 0
    contact_i_d: int = 0
    contact_name: Optional[str] = None
    budgeted_hours: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TimelineEquipment:
    project_job_equipment_i_d: int = 0
    equipment_i_d: int = 0
    equipment_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TimelineJob:
    job_i_d: int = 0
    job_name: Optional[str] = None
    expected_start_date: Optional[datetime.datetime] = None
    expected_completion_date: Optional[datetime.datetime] = None
    actual_start_date: Optional[datetime.datetime] = None
    actual_end_date: Optional[datetime.datetime] = None
    percent_complete: Decimal = decimal.Decimal(0)
    status_i_d: Optional[int] = None
    job_category: Optional[str] = None
    is_agreement_visit: bool = False
    occurrence_date: Optional[datetime.datetime] = None
    crew: List[TimelineCrew] = field(default_factory=list)
    equipment: List[TimelineEquipment] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class JobDependency:
    job_dependency_i_d: int = 0
    tenant_id: Optional[str] = None
    project_i_d: int = 0
    predecessor_job_i_d: int = 0
    successor_job_i_d: int = 0
    dependency_type: Optional[str] = None
    lag_days: int = 0
    created_by: Optional[str] = None
    created_at: Optional[datetime.datetime] = None
    updated_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProjectTimeline:
    project_i_d: int = 0
    jobs: List[TimelineJob] = field(default_factory=list)
    dependencies: List[JobDependency] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProjectTimelineResponse:
    response_status: Optional[ResponseStatus] = None
    timeline: Optional[ProjectTimeline] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProjectTimelineRequest:
    project_i_d: int = 0

Python ProjectTimelineRequest 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/project/{ProjectID}/timeline HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProjectTimelineResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <Timeline>
    <Dependencies>
      <JobDependency>
        <CreatedAt>0001-01-01T00:00:00</CreatedAt>
        <CreatedBy>String</CreatedBy>
        <DependencyType>String</DependencyType>
        <JobDependencyID>0</JobDependencyID>
        <LagDays>0</LagDays>
        <PredecessorJobID>0</PredecessorJobID>
        <ProjectID>0</ProjectID>
        <SuccessorJobID>0</SuccessorJobID>
        <TenantId>00000000-0000-0000-0000-000000000000</TenantId>
        <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
      </JobDependency>
    </Dependencies>
    <Jobs>
      <TimelineJob>
        <ActualEndDate>0001-01-01T00:00:00</ActualEndDate>
        <ActualStartDate>0001-01-01T00:00:00</ActualStartDate>
        <Crew>
          <TimelineCrew>
            <BudgetedHours>0</BudgetedHours>
            <ContactID>0</ContactID>
            <ContactName>String</ContactName>
            <ProjectJobCrewMemberID>0</ProjectJobCrewMemberID>
          </TimelineCrew>
        </Crew>
        <Equipment>
          <TimelineEquipment>
            <EquipmentID>0</EquipmentID>
            <EquipmentName>String</EquipmentName>
            <ProjectJobEquipmentID>0</ProjectJobEquipmentID>
          </TimelineEquipment>
        </Equipment>
        <ExpectedCompletionDate>0001-01-01T00:00:00</ExpectedCompletionDate>
        <ExpectedStartDate>0001-01-01T00:00:00</ExpectedStartDate>
        <IsAgreementVisit>false</IsAgreementVisit>
        <JobCategory>String</JobCategory>
        <JobID>0</JobID>
        <JobName>String</JobName>
        <OccurrenceDate>0001-01-01T00:00:00</OccurrenceDate>
        <PercentComplete>0</PercentComplete>
        <StatusID>0</StatusID>
      </TimelineJob>
    </Jobs>
    <ProjectID>0</ProjectID>
  </Timeline>
</ProjectTimelineResponse>