Trendsic Platform Service

ComparablesRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator

The following routes are available for this service:
GET,OPTIONS	/v1/Rfp/{RfpDocumentUID}/Comparables

namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ComparableLettingView() = 
        member val ProjectNumber:String = null with get,set
        member val LettingDate:DateTime = new DateTime() with get,set
        member val AgeYears:Decimal = new Decimal() with get,set
        member val Parish:String = null with get,set
        member val LettingUrl:String = null with get,set
        member val WinnerTotal:Decimal = new Decimal() with get,set
        member val SpreadPct:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val BidderCount:Int32 = new Int32() with get,set
        member val SharedCount:Int32 = new Int32() with get,set
        member val ItemCount:Int32 = new Int32() with get,set
        member val OverlapPct:Decimal = new Decimal() with get,set
        member val MobilizationPct:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val TrafficControlPct:Nullable<Decimal> = new Nullable<Decimal>() with get,set

    [<AllowNullLiteral>]
    type ComparablesSummaryView() = 
        member val MedianMobilizationPct:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val MedianTrafficControlPct:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val MedianSpreadPct:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val AppliedMobilizationPct:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Note:String = null with get,set

    [<AllowNullLiteral>]
    type ComparablesResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Comparables:ResizeArray<ComparableLettingView> = new ResizeArray<ComparableLettingView>() with get,set
        member val Summary:ComparablesSummaryView = null with get,set

    [<AllowNullLiteral>]
    type ComparablesRequest() = 
        member val RfpDocumentUID:Guid = new Guid() with get,set

F# ComparablesRequest 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}/Comparables HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ComparablesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Comparables>
    <ComparableLettingView>
      <AgeYears>0</AgeYears>
      <BidderCount>0</BidderCount>
      <ItemCount>0</ItemCount>
      <LettingDate>0001-01-01T00:00:00</LettingDate>
      <LettingUrl>String</LettingUrl>
      <MobilizationPct>0</MobilizationPct>
      <OverlapPct>0</OverlapPct>
      <Parish>String</Parish>
      <ProjectNumber>String</ProjectNumber>
      <SharedCount>0</SharedCount>
      <SpreadPct>0</SpreadPct>
      <TrafficControlPct>0</TrafficControlPct>
      <WinnerTotal>0</WinnerTotal>
    </ComparableLettingView>
  </Comparables>
  <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>
    <AppliedMobilizationPct>0</AppliedMobilizationPct>
    <MedianMobilizationPct>0</MedianMobilizationPct>
    <MedianSpreadPct>0</MedianSpreadPct>
    <MedianTrafficControlPct>0</MedianTrafficControlPct>
    <Note>String</Note>
  </Summary>
</ComparablesResponse>