Trendsic Platform Service

<back to all web services

ReleaseRetainageRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/projects/{ProjectID}/closeout/release-retainage
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class CloseoutStatus
            Public Overridable Property ProjectID As Integer
            Public Overridable Property TotalItems As Integer
            Public Overridable Property DoneCount As Integer
            Public Overridable Property OutstandingCount As Integer
            Public Overridable Property AllClear As Boolean
            Public Overridable Property RetainageAmount As Decimal
            Public Overridable Property RetainageReleased As Boolean
            Public Overridable Property ReleasedPayApplicationID As Integer?
            Public Overridable Property ReleasedInvoiceID As Integer?
            Public Overridable Property ReleasedAt As Date?
        End Class

        Public Partial Class ReleaseRetainageRequest
            Public Overridable Property ProjectID As Integer
        End Class

        Public Partial Class ReleaseRetainageResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property ProjectID As Integer
            Public Overridable Property Status As CloseoutStatus
            Public Overridable Property PayApplicationID As Integer?
            Public Overridable Property InvoiceID As Integer?
            Public Overridable Property RetainageReleased As Decimal
        End Class
    End Namespace
End Namespace

VB.NET ReleaseRetainageRequest 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.

POST /v1/projects/{ProjectID}/closeout/release-retainage HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ProjectID":0}

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,"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"},"PayApplicationID":0,"InvoiceID":0,"RetainageReleased":0}