PortfolioLinkApi

<back to all web services

DownloadProposalPlan

Requires Authentication
The following routes are available for this service:
All Verbs/v2/client/proposals/download
DownloadProposalPlan Parameters:
NameParameterData TypeRequiredDescription
GuidquerystringNo
TypequerystringNo
DownloadProposalPlanResponse Parameters:
NameParameterData TypeRequiredDescription
Dataformbyte[]No
ResponseformboolNo
FileNameformstringNo

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.

POST /v2/client/proposals/download HTTP/1.1 
Host: api.portfoliolink.co.za 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DownloadProposalPlan xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
  <Guid>String</Guid>
  <Type>String</Type>
</DownloadProposalPlan>

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

<DownloadProposalPlanResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
  <Data>AA==</Data>
  <FileName>String</FileName>
  <Response>false</Response>
</DownloadProposalPlanResponse>