| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/Rfp/{RfpDocumentUID}/Comparables |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
public static class ComparablesRequest
{
public UUID RfpDocumentUID = null;
public UUID getRfpDocumentUID() { return RfpDocumentUID; }
public ComparablesRequest setRfpDocumentUID(UUID value) { this.RfpDocumentUID = value; return this; }
}
public static class ComparablesResponse
{
public ResponseStatus ResponseStatus = null;
public ArrayList<ComparableLettingView> Comparables = new ArrayList<ComparableLettingView>();
public ComparablesSummaryView Summary = null;
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public ComparablesResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
public ArrayList<ComparableLettingView> getComparables() { return Comparables; }
public ComparablesResponse setComparables(ArrayList<ComparableLettingView> value) { this.Comparables = value; return this; }
public ComparablesSummaryView getSummary() { return Summary; }
public ComparablesResponse setSummary(ComparablesSummaryView value) { this.Summary = value; return this; }
}
public static class ComparableLettingView
{
public String ProjectNumber = null;
public Date LettingDate = null;
public BigDecimal AgeYears = null;
public String Parish = null;
public String LettingUrl = null;
public BigDecimal WinnerTotal = null;
public BigDecimal SpreadPct = null;
public Integer BidderCount = null;
public Integer SharedCount = null;
public Integer ItemCount = null;
public BigDecimal OverlapPct = null;
public BigDecimal MobilizationPct = null;
public BigDecimal TrafficControlPct = null;
public String getProjectNumber() { return ProjectNumber; }
public ComparableLettingView setProjectNumber(String value) { this.ProjectNumber = value; return this; }
public Date getLettingDate() { return LettingDate; }
public ComparableLettingView setLettingDate(Date value) { this.LettingDate = value; return this; }
public BigDecimal getAgeYears() { return AgeYears; }
public ComparableLettingView setAgeYears(BigDecimal value) { this.AgeYears = value; return this; }
public String getParish() { return Parish; }
public ComparableLettingView setParish(String value) { this.Parish = value; return this; }
public String getLettingUrl() { return LettingUrl; }
public ComparableLettingView setLettingUrl(String value) { this.LettingUrl = value; return this; }
public BigDecimal getWinnerTotal() { return WinnerTotal; }
public ComparableLettingView setWinnerTotal(BigDecimal value) { this.WinnerTotal = value; return this; }
public BigDecimal getSpreadPct() { return SpreadPct; }
public ComparableLettingView setSpreadPct(BigDecimal value) { this.SpreadPct = value; return this; }
public Integer getBidderCount() { return BidderCount; }
public ComparableLettingView setBidderCount(Integer value) { this.BidderCount = value; return this; }
public Integer getSharedCount() { return SharedCount; }
public ComparableLettingView setSharedCount(Integer value) { this.SharedCount = value; return this; }
public Integer getItemCount() { return ItemCount; }
public ComparableLettingView setItemCount(Integer value) { this.ItemCount = value; return this; }
public BigDecimal getOverlapPct() { return OverlapPct; }
public ComparableLettingView setOverlapPct(BigDecimal value) { this.OverlapPct = value; return this; }
public BigDecimal getMobilizationPct() { return MobilizationPct; }
public ComparableLettingView setMobilizationPct(BigDecimal value) { this.MobilizationPct = value; return this; }
public BigDecimal getTrafficControlPct() { return TrafficControlPct; }
public ComparableLettingView setTrafficControlPct(BigDecimal value) { this.TrafficControlPct = value; return this; }
}
public static class ComparablesSummaryView
{
public BigDecimal MedianMobilizationPct = null;
public BigDecimal MedianTrafficControlPct = null;
public BigDecimal MedianSpreadPct = null;
public BigDecimal AppliedMobilizationPct = null;
public String Note = null;
public BigDecimal getMedianMobilizationPct() { return MedianMobilizationPct; }
public ComparablesSummaryView setMedianMobilizationPct(BigDecimal value) { this.MedianMobilizationPct = value; return this; }
public BigDecimal getMedianTrafficControlPct() { return MedianTrafficControlPct; }
public ComparablesSummaryView setMedianTrafficControlPct(BigDecimal value) { this.MedianTrafficControlPct = value; return this; }
public BigDecimal getMedianSpreadPct() { return MedianSpreadPct; }
public ComparablesSummaryView setMedianSpreadPct(BigDecimal value) { this.MedianSpreadPct = value; return this; }
public BigDecimal getAppliedMobilizationPct() { return AppliedMobilizationPct; }
public ComparablesSummaryView setAppliedMobilizationPct(BigDecimal value) { this.AppliedMobilizationPct = value; return this; }
public String getNote() { return Note; }
public ComparablesSummaryView setNote(String value) { this.Note = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>