Trendsic Platform Service

<back to all web services

CloseoutListRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/projects/{ProjectID}/closeout
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 CloseoutItem() = 
        member val CloseoutItemID:Int32 = new Int32() with get,set
        member val CloseoutItemUID:Guid = new Guid() with get,set
        member val ProjectID:Int32 = new Int32() with get,set
        member val ItemKey:String = null with get,set
        member val Label:String = null with get,set
        member val Detail:String = null with get,set
        member val Status:String = null with get,set
        member val IsApplicable:Boolean = new Boolean() with get,set
        member val SortOrder:Int32 = new Int32() with get,set
        member val CompletedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CompletedBy:String = null 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 CloseoutStatus() = 
        member val ProjectID:Int32 = new Int32() with get,set
        member val TotalItems:Int32 = new Int32() with get,set
        member val DoneCount:Int32 = new Int32() with get,set
        member val OutstandingCount:Int32 = new Int32() with get,set
        member val AllClear:Boolean = new Boolean() with get,set
        member val RetainageAmount:Decimal = new Decimal() with get,set
        member val RetainageReleased:Boolean = new Boolean() with get,set
        member val ReleasedPayApplicationID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ReleasedInvoiceID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ReleasedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type CloseoutListResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val ProjectID:Int32 = new Int32() with get,set
        member val Items:ResizeArray<CloseoutItem> = new ResizeArray<CloseoutItem>() with get,set
        member val Status:CloseoutStatus = null with get,set

    [<AllowNullLiteral>]
    type CloseoutListRequest() = 
        member val ProjectID:Int32 = new Int32() with get,set

F# CloseoutListRequest 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/projects/{ProjectID}/closeout 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,
	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
	}
}