Trendsic Platform Service

<back to all web services

ProjectTimelineRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/project/{ProjectID}/timeline
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 TimelineCrew() = 
        member val ProjectJobCrewMemberID:Int32 = new Int32() with get,set
        member val ContactID:Int32 = new Int32() with get,set
        member val ContactName:String = null with get,set
        member val BudgetedHours:Nullable<Decimal> = new Nullable<Decimal>() with get,set

    [<AllowNullLiteral>]
    type TimelineEquipment() = 
        member val ProjectJobEquipmentID:Int32 = new Int32() with get,set
        member val EquipmentID:Int32 = new Int32() with get,set
        member val EquipmentName:String = null with get,set

    [<AllowNullLiteral>]
    type TimelineJob() = 
        member val JobID:Int32 = new Int32() with get,set
        member val JobName:String = null with get,set
        member val ExpectedStartDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ExpectedCompletionDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ActualStartDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ActualEndDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val PercentComplete:Decimal = new Decimal() with get,set
        member val StatusID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val JobCategory:String = null with get,set
        member val IsAgreementVisit:Boolean = new Boolean() with get,set
        member val OccurrenceDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Crew:ResizeArray<TimelineCrew> = new ResizeArray<TimelineCrew>() with get,set
        member val Equipment:ResizeArray<TimelineEquipment> = new ResizeArray<TimelineEquipment>() with get,set

    [<AllowNullLiteral>]
    type JobDependency() = 
        member val JobDependencyID:Int32 = new Int32() with get,set
        member val TenantId:Guid = new Guid() with get,set
        member val ProjectID:Int32 = new Int32() with get,set
        member val PredecessorJobID:Int32 = new Int32() with get,set
        member val SuccessorJobID:Int32 = new Int32() with get,set
        member val DependencyType:String = null with get,set
        member val LagDays:Int32 = new Int32() with get,set
        member val CreatedBy:String = null with get,set
        member val CreatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val UpdatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type ProjectTimeline() = 
        member val ProjectID:Int32 = new Int32() with get,set
        member val Jobs:ResizeArray<TimelineJob> = new ResizeArray<TimelineJob>() with get,set
        member val Dependencies:ResizeArray<JobDependency> = new ResizeArray<JobDependency>() with get,set

    [<AllowNullLiteral>]
    type ProjectTimelineResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Timeline:ProjectTimeline = null with get,set

    [<AllowNullLiteral>]
    type ProjectTimelineRequest() = 
        member val ProjectID:Int32 = new Int32() with get,set

F# 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>