PortfolioLinkApi

<back to all web services

GenerateReport

Requires Authentication
The following routes are available for this service:
All Verbs/pdf/generate
GenerateReport Parameters:
NameParameterData TypeRequiredDescription
TypequerystringNo
GoalResultsIdqueryintNo
GenerateReportResponse Parameters:
NameParameterData TypeRequiredDescription
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 /pdf/generate HTTP/1.1 
Host: api.portfoliolink.co.za 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GenerateReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
  <GoalResultsId>0</GoalResultsId>
  <Type>String</Type>
</GenerateReport>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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