| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/Rfp/{RfpDocumentUID}/Brief |
|---|
import Foundation
import ServiceStack
public class RfpBriefRequest : Codable
{
public var rfpDocumentUID:String
required public init(){}
}
public class RfpBriefResponse : Codable
{
public var responseStatus:ResponseStatus
public var rfpDocumentID:Int
public var brief:RfpBrief
required public init(){}
}
public class RfpBrief : Codable
{
public var projectTitle:String
public var solicitationNumber:String
public var issuingOrganization:String
public var projectType:String
public var summary:String
public var locations:[RfpLocation] = []
public var schedule:RfpSchedule
public var lineItems:[RfpLineItem] = []
public var bidConstraints:[RfpBidConstraint] = []
public var specialRequirements:[String] = []
required public init(){}
}
public class RfpLocation : Codable
{
public var Description:String
public var city:String
public var state:String
public var identifier:String
required public init(){}
}
public class RfpSchedule : Codable
{
public var bidDueDate:String
public var estimatedStartDate:String
public var questionsDueDate:String
public var contractDurationDays:Int?
public var notes:String
required public init(){}
}
public class RfpLineItem : Codable
{
public var itemNumber:String
public var Description:String
public var quantity:Double?
public var unit:String
public var category:String
public var sourceReference:String
required public init(){}
}
public class RfpBidConstraint : Codable
{
public var constraint:String
public var detail:String
required public init(){}
}
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}/Brief HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<RfpBriefResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Brief>
<BidConstraints>
<RfpBidConstraint>
<Constraint>String</Constraint>
<Detail>String</Detail>
</RfpBidConstraint>
</BidConstraints>
<IssuingOrganization>String</IssuingOrganization>
<LineItems>
<RfpLineItem>
<Category>String</Category>
<Description>String</Description>
<ItemNumber>String</ItemNumber>
<Quantity>0</Quantity>
<SourceReference>String</SourceReference>
<Unit>String</Unit>
</RfpLineItem>
</LineItems>
<Locations>
<RfpLocation>
<City>String</City>
<Description>String</Description>
<Identifier>String</Identifier>
<State>String</State>
</RfpLocation>
</Locations>
<ProjectTitle>String</ProjectTitle>
<ProjectType>String</ProjectType>
<Schedule>
<BidDueDate>String</BidDueDate>
<ContractDurationDays>0</ContractDurationDays>
<EstimatedStartDate>String</EstimatedStartDate>
<Notes>String</Notes>
<QuestionsDueDate>String</QuestionsDueDate>
</Schedule>
<SolicitationNumber>String</SolicitationNumber>
<SpecialRequirements xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</SpecialRequirements>
<Summary>String</Summary>
</Brief>
<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>
<RfpDocumentID>0</RfpDocumentID>
</RfpBriefResponse>