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}
"use strict";
export class CloseoutItem {
    /** @param {{CloseoutItemID?:number,CloseoutItemUID?:string,ProjectID?:number,ItemKey?:string,Label?:string,Detail?:string,Status?:string,IsApplicable?:boolean,SortOrder?:number,CompletedAt?:string,CompletedBy?:string,CreatedBy?:string,CreatedAt?:string,UpdatedAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CloseoutItemID;
    /** @type {string} */
    CloseoutItemUID;
    /** @type {number} */
    ProjectID;
    /** @type {string} */
    ItemKey;
    /** @type {string} */
    Label;
    /** @type {string} */
    Detail;
    /** @type {string} */
    Status;
    /** @type {boolean} */
    IsApplicable;
    /** @type {number} */
    SortOrder;
    /** @type {?string} */
    CompletedAt;
    /** @type {string} */
    CompletedBy;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {?string} */
    UpdatedAt;
}
export class CloseoutStatus {
    /** @param {{ProjectID?:number,TotalItems?:number,DoneCount?:number,OutstandingCount?:number,AllClear?:boolean,RetainageAmount?:number,RetainageReleased?:boolean,ReleasedPayApplicationID?:number,ReleasedInvoiceID?:number,ReleasedAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectID;
    /** @type {number} */
    TotalItems;
    /** @type {number} */
    DoneCount;
    /** @type {number} */
    OutstandingCount;
    /** @type {boolean} */
    AllClear;
    /** @type {number} */
    RetainageAmount;
    /** @type {boolean} */
    RetainageReleased;
    /** @type {?number} */
    ReleasedPayApplicationID;
    /** @type {?number} */
    ReleasedInvoiceID;
    /** @type {?string} */
    ReleasedAt;
}
export class CloseoutListResponse {
    /** @param {{ResponseStatus?:ResponseStatus,ProjectID?:number,Items?:CloseoutItem[],Status?:CloseoutStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {number} */
    ProjectID;
    /** @type {CloseoutItem[]} */
    Items = [];
    /** @type {CloseoutStatus} */
    Status;
}
export class CloseoutItemPatchRequest {
    /** @param {{ProjectID?:number,CloseoutItemID?:number,Status?:string,Detail?:string,IsApplicable?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectID;
    /** @type {number} */
    CloseoutItemID;
    /** @type {string} */
    Status;
    /** @type {string} */
    Detail;
    /** @type {?boolean} */
    IsApplicable;
}

JavaScript CloseoutItemPatchRequest 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.

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

<CloseoutItemPatchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CloseoutItemID>0</CloseoutItemID>
  <Detail>String</Detail>
  <IsApplicable>false</IsApplicable>
  <ProjectID>0</ProjectID>
  <Status>String</Status>
</CloseoutItemPatchRequest>
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>