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 .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
			}
		]
	}
}