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 .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.

POST /pdf/generate HTTP/1.1 
Host: api.portfoliolink.co.za 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	type: String,
	goalResultsId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	fileName: String
}