Trendsic Platform Service

<back to all web services

ChangeOrderListRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/projects/{ProjectID}/change-orders
ChangeOrderListRequest Parameters:
NameParameterData TypeRequiredDescription
ProjectIDpathintNo
ChangeOrderListResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ProjectIDformintNo
OrdersformList<ChangeOrder>No
SummaryformChangeOrderContractSummaryNo
ChangeOrder Parameters:
NameParameterData TypeRequiredDescription
ChangeOrderIDformintNo
ChangeOrderUIDformGuidNo
ProjectIDformintNo
CONumberformstringNo
TitleformstringNo
ScopeformstringNo
StatusformstringNo
CostUSDformdecimalNo
PriceUSDformdecimalNo
ScheduleDaysformintNo
OverheadProfitPctformdecimalNo
PricingMethodformstringNo
OriginTypeformstringNo
OriginRefformstringNo
CostCodeformstringNo
OpenedAtformDateTime?No
SubmittedAtformDateTime?No
DecidedAtformDateTime?No
CreatedByformstringNo
CreatedAtformDateTime?No
UpdatedAtformDateTime?No
DaysOpenformintNo
LinesformList<ChangeOrderLine>No
ChangeOrderLine Parameters:
NameParameterData TypeRequiredDescription
ChangeOrderLineIDformintNo
ChangeOrderIDformintNo
CategoryformstringNo
DescriptionformstringNo
CostUSDformdecimalNo
MarkupPctformdecimalNo
CostCodeformstringNo
SortOrderformintNo
ChangeOrderContractSummary Parameters:
NameParameterData TypeRequiredDescription
ProjectIDformintNo
OriginalContractformdecimalNo
ApprovedCOValueformdecimalNo
ApprovedCOCountformintNo
PendingCOValueformdecimalNo
PendingCOCountformintNo
RevisedContractformdecimalNo
PotentialContractformdecimalNo
ApprovedScheduleDaysformintNo

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/projects/{ProjectID}/change-orders 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
		}
	},
	ProjectID: 0,
	Orders: 
	[
		{
			ChangeOrderID: 0,
			ChangeOrderUID: 00000000000000000000000000000000,
			ProjectID: 0,
			CONumber: String,
			Title: String,
			Scope: String,
			Status: String,
			CostUSD: 0,
			PriceUSD: 0,
			ScheduleDays: 0,
			OverheadProfitPct: 0,
			PricingMethod: String,
			OriginType: String,
			OriginRef: String,
			CostCode: String,
			OpenedAt: 0001-01-01,
			SubmittedAt: 0001-01-01,
			DecidedAt: 0001-01-01,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedAt: 0001-01-01,
			DaysOpen: 0,
			Lines: 
			[
				{
					ChangeOrderLineID: 0,
					ChangeOrderID: 0,
					Category: String,
					Description: String,
					CostUSD: 0,
					MarkupPct: 0,
					CostCode: String,
					SortOrder: 0
				}
			]
		}
	],
	Summary: 
	{
		ProjectID: 0,
		OriginalContract: 0,
		ApprovedCOValue: 0,
		ApprovedCOCount: 0,
		PendingCOValue: 0,
		PendingCOCount: 0,
		RevisedContract: 0,
		PotentialContract: 0,
		ApprovedScheduleDays: 0
	}
}