Trendsic Platform Service

<back to all web services

CloseoutItemPatchRequest

Requires Authentication
The following routes are available for this service:
PATCH,PUT,OPTIONS/v1/projects/{ProjectID}/closeout/{CloseoutItemID}
CloseoutItemPatchRequest Parameters:
NameParameterData TypeRequiredDescription
ProjectIDpathintNo
CloseoutItemIDpathintNo
StatusbodystringNo
DetailbodystringNo
IsApplicablebodybool?No
CloseoutListResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ProjectIDformintNo
ItemsformList<CloseoutItem>No
StatusformCloseoutStatusNo
CloseoutItem Parameters:
NameParameterData TypeRequiredDescription
CloseoutItemIDformintNo
CloseoutItemUIDformGuidNo
ProjectIDformintNo
ItemKeyformstringNo
LabelformstringNo
DetailformstringNo
StatusformstringNo
IsApplicableformboolNo
SortOrderformintNo
CompletedAtformDateTime?No
CompletedByformstringNo
CreatedByformstringNo
CreatedAtformDateTime?No
UpdatedAtformDateTime?No
CloseoutStatus Parameters:
NameParameterData TypeRequiredDescription
ProjectIDformintNo
TotalItemsformintNo
DoneCountformintNo
OutstandingCountformintNo
AllClearformboolNo
RetainageAmountformdecimalNo
RetainageReleasedformboolNo
ReleasedPayApplicationIDformint?No
ReleasedInvoiceIDformint?No
ReleasedAtformDateTime?No

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.

PUT /v1/projects/{ProjectID}/closeout/{CloseoutItemID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ProjectID: 0,
	CloseoutItemID: 0,
	Status: String,
	Detail: String,
	IsApplicable: False
}
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,
	Items: 
	[
		{
			CloseoutItemID: 0,
			CloseoutItemUID: 00000000000000000000000000000000,
			ProjectID: 0,
			ItemKey: String,
			Label: String,
			Detail: String,
			Status: String,
			IsApplicable: False,
			SortOrder: 0,
			CompletedAt: 0001-01-01,
			CompletedBy: String,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedAt: 0001-01-01
		}
	],
	Status: 
	{
		ProjectID: 0,
		TotalItems: 0,
		DoneCount: 0,
		OutstandingCount: 0,
		AllClear: False,
		RetainageAmount: 0,
		RetainageReleased: False,
		ReleasedPayApplicationID: 0,
		ReleasedInvoiceID: 0,
		ReleasedAt: 0001-01-01
	}
}