Trendsic Platform Service

<back to all web services

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 .other suffix or ?format=other

HTTP + OTHER

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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Comparables":[{"ProjectNumber":"String","LettingDate":"0001-01-01T00:00:00.0000000","AgeYears":0,"Parish":"String","LettingUrl":"String","WinnerTotal":0,"SpreadPct":0,"BidderCount":0,"SharedCount":0,"ItemCount":0,"OverlapPct":0,"MobilizationPct":0,"TrafficControlPct":0}],"Summary":{"MedianMobilizationPct":0,"MedianTrafficControlPct":0,"MedianSpreadPct":0,"AppliedMobilizationPct":0,"Note":"String"}}