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}
import Foundation
import ServiceStack

public class CloseoutItemPatchRequest : Codable
{
    public var projectID:Int
    public var closeoutItemID:Int
    public var status:String
    public var detail:String
    public var isApplicable:Bool?

    required public init(){}
}

public class CloseoutListResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var projectID:Int
    public var items:[CloseoutItem] = []
    public var status:CloseoutStatus

    required public init(){}
}

public class CloseoutItem : Codable
{
    public var closeoutItemID:Int
    public var closeoutItemUID:String
    public var projectID:Int
    public var itemKey:String
    public var label:String
    public var detail:String
    public var status:String
    public var isApplicable:Bool
    public var sortOrder:Int
    public var completedAt:Date?
    public var completedBy:String
    public var createdBy:String
    public var createdAt:Date?
    public var updatedAt:Date?

    required public init(){}
}

public class CloseoutStatus : Codable
{
    public var projectID:Int
    public var totalItems:Int
    public var doneCount:Int
    public var outstandingCount:Int
    public var allClear:Bool
    public var retainageAmount:Double
    public var retainageReleased:Bool
    public var releasedPayApplicationID:Int?
    public var releasedInvoiceID:Int?
    public var releasedAt:Date?

    required public init(){}
}


Swift CloseoutItemPatchRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"ProjectID":0,"CloseoutItemID":0,"Status":"String","Detail":"String","IsApplicable":false}
HTTP/1.1 200 OK
Content-Type: application/json
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-01T00:00:00.0000000","CompletedBy":"String","CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"}],"Status":{"ProjectID":0,"TotalItems":0,"DoneCount":0,"OutstandingCount":0,"AllClear":false,"RetainageAmount":0,"RetainageReleased":false,"ReleasedPayApplicationID":0,"ReleasedInvoiceID":0,"ReleasedAt":"0001-01-01T00:00:00.0000000"}}