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

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class ComparableLettingView
            Public Overridable Property ProjectNumber As String
            Public Overridable Property LettingDate As Date
            Public Overridable Property AgeYears As Decimal
            Public Overridable Property Parish As String
            Public Overridable Property LettingUrl As String
            Public Overridable Property WinnerTotal As Decimal
            Public Overridable Property SpreadPct As Decimal?
            Public Overridable Property BidderCount As Integer
            Public Overridable Property SharedCount As Integer
            Public Overridable Property ItemCount As Integer
            Public Overridable Property OverlapPct As Decimal
            Public Overridable Property MobilizationPct As Decimal?
            Public Overridable Property TrafficControlPct As Decimal?
        End Class

        Public Partial Class ComparablesRequest
            Public Overridable Property RfpDocumentUID As Guid
        End Class

        Public Partial Class ComparablesResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Comparables As List(Of ComparableLettingView) = New List(Of ComparableLettingView)
            Public Overridable Property Summary As ComparablesSummaryView
        End Class

        Public Partial Class ComparablesSummaryView
            Public Overridable Property MedianMobilizationPct As Decimal?
            Public Overridable Property MedianTrafficControlPct As Decimal?
            Public Overridable Property MedianSpreadPct As Decimal?
            Public Overridable Property AppliedMobilizationPct As Decimal?
            Public Overridable Property Note As String
        End Class
    End Namespace
End Namespace

VB.NET ComparablesRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
			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
	}
}