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}
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 RevisionLineDelta:
    item_no: Optional[str] = None
    description: Optional[str] = None
    unit: Optional[str] = None
    change: Optional[str] = None
    quantity_a: Optional[Decimal] = None
    quantity_b: Optional[Decimal] = None
    unit_price_a: Optional[Decimal] = None
    unit_price_b: Optional[Decimal] = None
    extension_a: Decimal = decimal.Decimal(0)
    extension_b: Decimal = decimal.Decimal(0)
    quantity_delta: Decimal = decimal.Decimal(0)
    unit_price_delta: Decimal = decimal.Decimal(0)
    extension_delta: Decimal = decimal.Decimal(0)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TaskDiff:
    task_name: Optional[str] = None
    positions_added: List[str] = field(default_factory=list)
    positions_removed: List[str] = field(default_factory=list)
    positions_staffed: List[str] = field(default_factory=list)
    equipment_added: List[int] = field(default_factory=list)
    equipment_removed: List[int] = field(default_factory=list)
    materials_added: List[int] = field(default_factory=list)
    materials_removed: List[int] = field(default_factory=list)
    has_changes: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProposalDiff:
    tasks_added: List[str] = field(default_factory=list)
    tasks_removed: List[str] = field(default_factory=list)
    tasks: List[TaskDiff] = field(default_factory=list)
    has_changes: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EstimateRevisionCompareResult:
    revision_a: int = 0
    revision_b: int = 0
    label_a: Optional[str] = None
    label_b: Optional[str] = None
    total_a: Decimal = decimal.Decimal(0)
    total_b: Decimal = decimal.Decimal(0)
    total_delta: Decimal = decimal.Decimal(0)
    bid_total_a: Decimal = decimal.Decimal(0)
    bid_total_b: Decimal = decimal.Decimal(0)
    added: int = 0
    removed: int = 0
    changed: int = 0
    unchanged: int = 0
    lines: List[RevisionLineDelta] = field(default_factory=list)
    scope: Optional[ProposalDiff] = None
    summary: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EstimateRevisionCompareResponse:
    response_status: Optional[ResponseStatus] = None
    compare: Optional[EstimateRevisionCompareResult] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EstimateRevisionCompareRequest:
    rfp_document_u_i_d: Optional[str] = None
    revision_a: int = 0
    revision_b: int = 0

Python 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>