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
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 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 ReleaseRetainageResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val ProjectID:Int32 = new Int32() with get,set
        member val Status:CloseoutStatus = null with get,set
        member val PayApplicationID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val InvoiceID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RetainageReleased:Decimal = new Decimal() with get,set

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

F# ReleaseRetainageRequest DTOs

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

HTTP + XML

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

<ReleaseRetainageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ProjectID>0</ProjectID>
</ReleaseRetainageRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ReleaseRetainageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <InvoiceID>0</InvoiceID>
  <PayApplicationID>0</PayApplicationID>
  <ProjectID>0</ProjectID>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <RetainageReleased>0</RetainageReleased>
  <Status>
    <AllClear>false</AllClear>
    <DoneCount>0</DoneCount>
    <OutstandingCount>0</OutstandingCount>
    <ProjectID>0</ProjectID>
    <ReleasedAt>0001-01-01T00:00:00</ReleasedAt>
    <ReleasedInvoiceID>0</ReleasedInvoiceID>
    <ReleasedPayApplicationID>0</ReleasedPayApplicationID>
    <RetainageAmount>0</RetainageAmount>
    <RetainageReleased>false</RetainageReleased>
    <TotalItems>0</TotalItems>
  </Status>
</ReleaseRetainageResponse>