Trendsic Platform Service

<back to all web services

PmProjectsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/pm/projects
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 PmProjectRow() = 
        member val ProjectID:Int32 = new Int32() with get,set
        member val ProjectUID:String = null with get,set
        member val Name:String = null with get,set
        member val Client:String = null with get,set
        member val ProjectType:String = null with get,set
        member val Status:String = null with get,set
        member val Branch:String = null with get,set
        member val StartDate:String = null with get,set
        member val EndDate:String = null with get,set
        member val Budget:Double = new Double() with get,set
        member val Spent:Double = new Double() with get,set
        member val EstimatedCost:Double = new Double() with get,set
        member val HealthPct:Int32 = new Int32() with get,set
        member val JobCount:Int32 = new Int32() with get,set
        member val OpenJobs:Int32 = new Int32() with get,set
        member val GapCount:Int32 = new Int32() with get,set
        member val OverBudget:Boolean = new Boolean() with get,set
        member val ProgressPct:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type PmPortfolioTotals() = 
        member val Projects:Int32 = new Int32() with get,set
        member val Budget:Double = new Double() with get,set
        member val Spent:Double = new Double() with get,set
        member val OverBudget:Int32 = new Int32() with get,set
        member val WithGaps:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type PmProjectsResponse() = 
        member val Projects:ResizeArray<PmProjectRow> = new ResizeArray<PmProjectRow>() with get,set
        member val Totals:PmPortfolioTotals = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type PmProjectsRequest() = 
        member val Search:String = null with get,set

F# PmProjectsRequest 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/pm/projects HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Projects: 
	[
		{
			ProjectID: 0,
			ProjectUID: String,
			Name: String,
			Client: String,
			ProjectType: String,
			Status: String,
			Branch: String,
			StartDate: String,
			EndDate: String,
			Budget: 0,
			Spent: 0,
			EstimatedCost: 0,
			HealthPct: 0,
			JobCount: 0,
			OpenJobs: 0,
			GapCount: 0,
			OverBudget: False,
			ProgressPct: 0
		}
	],
	Totals: 
	{
		Projects: 0,
		Budget: 0,
		Spent: 0,
		OverBudget: 0,
		WithGaps: 0
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}