| GET,OPTIONS | /v1/projects/{ProjectID}/closeout |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CloseoutItem:
closeout_item_i_d: int = 0
closeout_item_u_i_d: Optional[str] = None
project_i_d: int = 0
item_key: Optional[str] = None
label: Optional[str] = None
detail: Optional[str] = None
status: Optional[str] = None
is_applicable: bool = False
sort_order: int = 0
completed_at: Optional[datetime.datetime] = None
completed_by: Optional[str] = None
created_by: Optional[str] = None
created_at: Optional[datetime.datetime] = None
updated_at: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CloseoutStatus:
project_i_d: int = 0
total_items: int = 0
done_count: int = 0
outstanding_count: int = 0
all_clear: bool = False
retainage_amount: Decimal = decimal.Decimal(0)
retainage_released: bool = False
released_pay_application_i_d: Optional[int] = None
released_invoice_i_d: Optional[int] = None
released_at: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CloseoutListResponse:
response_status: Optional[ResponseStatus] = None
project_i_d: int = 0
items: List[CloseoutItem] = field(default_factory=list)
status: Optional[CloseoutStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CloseoutListRequest:
project_i_d: int = 0
Python CloseoutListRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>