Trendsic Platform Service

<back to all web services

ChangeOrderVoidRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/projects/{ProjectID}/change-orders/{ChangeOrderID}/void

export class ChangeOrderLine
{
    public ChangeOrderLineID: number;
    public ChangeOrderID: number;
    public Category: string;
    public Description: string;
    public CostUSD: number;
    public MarkupPct: number;
    public CostCode: string;
    public SortOrder: number;

    public constructor(init?: Partial<ChangeOrderLine>) { (Object as any).assign(this, init); }
}

export class ChangeOrder
{
    public ChangeOrderID: number;
    public ChangeOrderUID: string;
    public ProjectID: number;
    public CONumber: string;
    public Title: string;
    public Scope: string;
    public Status: string;
    public CostUSD: number;
    public PriceUSD: number;
    public ScheduleDays: number;
    public OverheadProfitPct: number;
    public PricingMethod: string;
    public OriginType: string;
    public OriginRef: string;
    public CostCode: string;
    public OpenedAt?: string;
    public SubmittedAt?: string;
    public DecidedAt?: string;
    public CreatedBy: string;
    public CreatedAt?: string;
    public UpdatedAt?: string;
    public DaysOpen: number;
    public Lines: ChangeOrderLine[] = [];

    public constructor(init?: Partial<ChangeOrder>) { (Object as any).assign(this, init); }
}

export class ChangeOrderContractSummary
{
    public ProjectID: number;
    public OriginalContract: number;
    public ApprovedCOValue: number;
    public ApprovedCOCount: number;
    public PendingCOValue: number;
    public PendingCOCount: number;
    public RevisedContract: number;
    public PotentialContract: number;
    public ApprovedScheduleDays: number;

    public constructor(init?: Partial<ChangeOrderContractSummary>) { (Object as any).assign(this, init); }
}

export class ChangeOrderResponse
{
    public ResponseStatus: ResponseStatus;
    public Order: ChangeOrder;
    public Summary: ChangeOrderContractSummary;

    public constructor(init?: Partial<ChangeOrderResponse>) { (Object as any).assign(this, init); }
}

export class ChangeOrderVoidRequest
{
    public ProjectID: number;
    public ChangeOrderID: number;

    public constructor(init?: Partial<ChangeOrderVoidRequest>) { (Object as any).assign(this, init); }
}

TypeScript ChangeOrderVoidRequest 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}/change-orders/{ChangeOrderID}/void HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<ChangeOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Order>
    <CONumber>String</CONumber>
    <ChangeOrderID>0</ChangeOrderID>
    <ChangeOrderUID>00000000-0000-0000-0000-000000000000</ChangeOrderUID>
    <CostCode>String</CostCode>
    <CostUSD>0</CostUSD>
    <CreatedAt>0001-01-01T00:00:00</CreatedAt>
    <CreatedBy>String</CreatedBy>
    <DaysOpen>0</DaysOpen>
    <DecidedAt>0001-01-01T00:00:00</DecidedAt>
    <Lines>
      <ChangeOrderLine>
        <Category>String</Category>
        <ChangeOrderID>0</ChangeOrderID>
        <ChangeOrderLineID>0</ChangeOrderLineID>
        <CostCode>String</CostCode>
        <CostUSD>0</CostUSD>
        <Description>String</Description>
        <MarkupPct>0</MarkupPct>
        <SortOrder>0</SortOrder>
      </ChangeOrderLine>
    </Lines>
    <OpenedAt>0001-01-01T00:00:00</OpenedAt>
    <OriginRef>String</OriginRef>
    <OriginType>String</OriginType>
    <OverheadProfitPct>0</OverheadProfitPct>
    <PriceUSD>0</PriceUSD>
    <PricingMethod>String</PricingMethod>
    <ProjectID>0</ProjectID>
    <ScheduleDays>0</ScheduleDays>
    <Scope>String</Scope>
    <Status>String</Status>
    <SubmittedAt>0001-01-01T00:00:00</SubmittedAt>
    <Title>String</Title>
    <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
  </Order>
  <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>
  <Summary>
    <ApprovedCOCount>0</ApprovedCOCount>
    <ApprovedCOValue>0</ApprovedCOValue>
    <ApprovedScheduleDays>0</ApprovedScheduleDays>
    <OriginalContract>0</OriginalContract>
    <PendingCOCount>0</PendingCOCount>
    <PendingCOValue>0</PendingCOValue>
    <PotentialContract>0</PotentialContract>
    <ProjectID>0</ProjectID>
    <RevisedContract>0</RevisedContract>
  </Summary>
</ChangeOrderResponse>