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
import Foundation
import ServiceStack

public class ProjectTimelineRequest : Codable
{
    public var projectID:Int

    required public init(){}
}

public class ProjectTimelineResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var timeline:ProjectTimeline

    required public init(){}
}

public class ProjectTimeline : Codable
{
    public var projectID:Int
    public var jobs:[TimelineJob] = []
    public var dependencies:[JobDependency] = []

    required public init(){}
}

public class TimelineJob : Codable
{
    public var jobID:Int
    public var jobName:String
    public var expectedStartDate:Date?
    public var expectedCompletionDate:Date?
    public var actualStartDate:Date?
    public var actualEndDate:Date?
    public var percentComplete:Double
    public var statusID:Int?
    public var jobCategory:String
    public var isAgreementVisit:Bool
    public var occurrenceDate:Date?
    public var crew:[TimelineCrew] = []
    public var equipment:[TimelineEquipment] = []

    required public init(){}
}

public class TimelineCrew : Codable
{
    public var projectJobCrewMemberID:Int
    public var contactID:Int
    public var contactName:String
    public var budgetedHours:Double?

    required public init(){}
}

public class TimelineEquipment : Codable
{
    public var projectJobEquipmentID:Int
    public var equipmentID:Int
    public var equipmentName:String

    required public init(){}
}

public class JobDependency : Codable
{
    public var jobDependencyID:Int
    public var tenantId:String
    public var projectID:Int
    public var predecessorJobID:Int
    public var successorJobID:Int
    public var dependencyType:String
    public var lagDays:Int
    public var createdBy:String
    public var createdAt:Date?
    public var updatedAt:Date?

    required public init(){}
}


Swift ProjectTimelineRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Timeline: 
	{
		ProjectID: 0,
		Jobs: 
		[
			{
				JobID: 0,
				JobName: String,
				ExpectedStartDate: 0001-01-01,
				ExpectedCompletionDate: 0001-01-01,
				ActualStartDate: 0001-01-01,
				ActualEndDate: 0001-01-01,
				PercentComplete: 0,
				StatusID: 0,
				JobCategory: String,
				IsAgreementVisit: False,
				OccurrenceDate: 0001-01-01,
				Crew: 
				[
					{
						ProjectJobCrewMemberID: 0,
						ContactID: 0,
						ContactName: String,
						BudgetedHours: 0
					}
				],
				Equipment: 
				[
					{
						ProjectJobEquipmentID: 0,
						EquipmentID: 0,
						EquipmentName: String
					}
				]
			}
		],
		Dependencies: 
		[
			{
				JobDependencyID: 0,
				TenantId: 00000000000000000000000000000000,
				ProjectID: 0,
				PredecessorJobID: 0,
				SuccessorJobID: 0,
				DependencyType: String,
				LagDays: 0,
				CreatedBy: String,
				CreatedAt: 0001-01-01,
				UpdatedAt: 0001-01-01
			}
		]
	}
}