Trendsic Platform Service

<back to all web services

EstimateRevisionCompareRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/Rfp/{RfpDocumentUID}/Estimate/Revisions/{RevisionA}/Compare/{RevisionB}
"use strict";
export class RevisionLineDelta {
    /** @param {{ItemNo?:string,Description?:string,Unit?:string,Change?:string,QuantityA?:number,QuantityB?:number,UnitPriceA?:number,UnitPriceB?:number,ExtensionA?:number,ExtensionB?:number,QuantityDelta?:number,UnitPriceDelta?:number,ExtensionDelta?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ItemNo;
    /** @type {string} */
    Description;
    /** @type {string} */
    Unit;
    /** @type {string} */
    Change;
    /** @type {?number} */
    QuantityA;
    /** @type {?number} */
    QuantityB;
    /** @type {?number} */
    UnitPriceA;
    /** @type {?number} */
    UnitPriceB;
    /** @type {number} */
    ExtensionA;
    /** @type {number} */
    ExtensionB;
    /** @type {number} */
    QuantityDelta;
    /** @type {number} */
    UnitPriceDelta;
    /** @type {number} */
    ExtensionDelta;
}
export class TaskDiff {
    /** @param {{TaskName?:string,PositionsAdded?:string[],PositionsRemoved?:string[],PositionsStaffed?:string[],EquipmentAdded?:number[],EquipmentRemoved?:number[],MaterialsAdded?:number[],MaterialsRemoved?:number[],HasChanges?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    TaskName;
    /** @type {string[]} */
    PositionsAdded = [];
    /** @type {string[]} */
    PositionsRemoved = [];
    /** @type {string[]} */
    PositionsStaffed = [];
    /** @type {number[]} */
    EquipmentAdded = [];
    /** @type {number[]} */
    EquipmentRemoved = [];
    /** @type {number[]} */
    MaterialsAdded = [];
    /** @type {number[]} */
    MaterialsRemoved = [];
    /** @type {boolean} */
    HasChanges;
}
export class ProposalDiff {
    /** @param {{TasksAdded?:string[],TasksRemoved?:string[],Tasks?:TaskDiff[],HasChanges?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string[]} */
    TasksAdded = [];
    /** @type {string[]} */
    TasksRemoved = [];
    /** @type {TaskDiff[]} */
    Tasks = [];
    /** @type {boolean} */
    HasChanges;
}
export class EstimateRevisionCompareResult {
    /** @param {{RevisionA?:number,RevisionB?:number,LabelA?:string,LabelB?:string,TotalA?:number,TotalB?:number,TotalDelta?:number,BidTotalA?:number,BidTotalB?:number,Added?:number,Removed?:number,Changed?:number,Unchanged?:number,Lines?:RevisionLineDelta[],Scope?:ProposalDiff,Summary?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    RevisionA;
    /** @type {number} */
    RevisionB;
    /** @type {string} */
    LabelA;
    /** @type {string} */
    LabelB;
    /** @type {number} */
    TotalA;
    /** @type {number} */
    TotalB;
    /** @type {number} */
    TotalDelta;
    /** @type {number} */
    BidTotalA;
    /** @type {number} */
    BidTotalB;
    /** @type {number} */
    Added;
    /** @type {number} */
    Removed;
    /** @type {number} */
    Changed;
    /** @type {number} */
    Unchanged;
    /** @type {RevisionLineDelta[]} */
    Lines = [];
    /** @type {ProposalDiff} */
    Scope;
    /** @type {string} */
    Summary;
}
export class EstimateRevisionCompareResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Compare?:EstimateRevisionCompareResult}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {EstimateRevisionCompareResult} */
    Compare;
}
export class EstimateRevisionCompareRequest {
    /** @param {{RfpDocumentUID?:string,RevisionA?:number,RevisionB?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RfpDocumentUID;
    /** @type {number} */
    RevisionA;
    /** @type {number} */
    RevisionB;
}

JavaScript EstimateRevisionCompareRequest 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/Rfp/{RfpDocumentUID}/Estimate/Revisions/{RevisionA}/Compare/{RevisionB} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EstimateRevisionCompareResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Compare>
    <Added>0</Added>
    <BidTotalA>0</BidTotalA>
    <BidTotalB>0</BidTotalB>
    <Changed>0</Changed>
    <LabelA>String</LabelA>
    <LabelB>String</LabelB>
    <Lines>
      <RevisionLineDelta>
        <Change>String</Change>
        <Description>String</Description>
        <ExtensionA>0</ExtensionA>
        <ExtensionB>0</ExtensionB>
        <ItemNo>String</ItemNo>
        <QuantityA>0</QuantityA>
        <QuantityB>0</QuantityB>
        <Unit>String</Unit>
        <UnitPriceA>0</UnitPriceA>
        <UnitPriceB>0</UnitPriceB>
      </RevisionLineDelta>
    </Lines>
    <Removed>0</Removed>
    <RevisionA>0</RevisionA>
    <RevisionB>0</RevisionB>
    <Scope>
      <Tasks>
        <TaskDiff>
          <EquipmentAdded xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>0</d6p1:int>
          </EquipmentAdded>
          <EquipmentRemoved xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>0</d6p1:int>
          </EquipmentRemoved>
          <MaterialsAdded xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>0</d6p1:int>
          </MaterialsAdded>
          <MaterialsRemoved xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>0</d6p1:int>
          </MaterialsRemoved>
          <PositionsAdded xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </PositionsAdded>
          <PositionsRemoved xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </PositionsRemoved>
          <PositionsStaffed xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </PositionsStaffed>
          <TaskName>String</TaskName>
        </TaskDiff>
      </Tasks>
      <TasksAdded xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </TasksAdded>
      <TasksRemoved xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </TasksRemoved>
    </Scope>
    <Summary>String</Summary>
    <TotalA>0</TotalA>
    <TotalB>0</TotalB>
    <Unchanged>0</Unchanged>
  </Compare>
  <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>
</EstimateRevisionCompareResponse>