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
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 CloseoutItem
            Public Overridable Property CloseoutItemID As Integer
            Public Overridable Property CloseoutItemUID As Guid
            Public Overridable Property ProjectID As Integer
            Public Overridable Property ItemKey As String
            Public Overridable Property Label As String
            Public Overridable Property Detail As String
            Public Overridable Property Status As String
            Public Overridable Property IsApplicable As Boolean
            Public Overridable Property SortOrder As Integer
            Public Overridable Property CompletedAt As Date?
            Public Overridable Property CompletedBy As String
            Public Overridable Property CreatedBy As String
            Public Overridable Property CreatedAt As Date?
            Public Overridable Property UpdatedAt As Date?
        End Class

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

        Public Partial Class CloseoutListResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property ProjectID As Integer
            Public Overridable Property Items As List(Of CloseoutItem) = New List(Of CloseoutItem)
            Public Overridable Property Status As CloseoutStatus
        End Class

        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
    End Namespace
End Namespace

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

GET /v1/projects/{ProjectID}/closeout HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CloseoutListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Items>
    <CloseoutItem>
      <CloseoutItemID>0</CloseoutItemID>
      <CloseoutItemUID>00000000-0000-0000-0000-000000000000</CloseoutItemUID>
      <CompletedAt>0001-01-01T00:00:00</CompletedAt>
      <CompletedBy>String</CompletedBy>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <Detail>String</Detail>
      <IsApplicable>false</IsApplicable>
      <ItemKey>String</ItemKey>
      <Label>String</Label>
      <ProjectID>0</ProjectID>
      <SortOrder>0</SortOrder>
      <Status>String</Status>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    </CloseoutItem>
  </Items>
  <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>
  <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>
</CloseoutListResponse>