JiwaAPI

<back to all web services

ReportsPDFGETRequest

Requires Authentication
The following routes are available for this service:
GET/Reports/{ReportID}/PDF/DownloadRetrieves PDF of the selected report.
ReportsPDFGETRequest Parameters:
NameParameterData TypeRequiredDescription
ReportIDpathstringNo
ReportParametersqueryList<ReportParameter>No
AsAttachmentqueryboolNo
ReportParameter Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformstringNo
IHttpResult Parameters:
NameParameterData TypeRequiredDescription
StatusformintNo
StatusCodeformHttpStatusCodeNo
StatusDescriptionformstringNo
ContentTypeformstringNo
HeadersformDictionary<string, string>No
CookiesformList<Cookie>No
ResponseformObjectNo
ResponseFilterformIContentTypeWriterNo
RequestContextformIRequestNo
PaddingLengthformintNo
ResultScopeformFunc<IDisposable>No
IRequest Parameters:
NameParameterData TypeRequiredDescription
OriginalRequestformObjectNo
ResponseformIResponseNo
OperationNameformstringNo
VerbformstringNo
RequestAttributesformRequestAttributesNo
RequestPreferencesformIRequestPreferencesNo
DtoformObjectNo
ContentTypeformstringNo
IsLocalformboolNo
UserAgentformstringNo
CookiesformIDictionary<string, Cookie>No
ResponseContentTypeformstringNo
HasExplicitResponseContentTypeformboolNo
ItemsformDictionary<string, Object>No
HeadersformNameValueCollectionNo
QueryStringformNameValueCollectionNo
FormDataformNameValueCollectionNo
UseBufferedStreamformboolNo
RawUrlformstringNo
AbsoluteUriformstringNo
UserHostAddressformstringNo
RemoteIpformstringNo
AuthorizationformstringNo
IsSecureConnectionformboolNo
AcceptTypesformstring[]No
PathInfoformstringNo
OriginalPathInfoformstringNo
ContentLengthformlongNo
FilesformIHttpFile[]No
UrlReferrerformUriNo
IResponse Parameters:
NameParameterData TypeRequiredDescription
OriginalResponseformObjectNo
RequestformIRequestNo
StatusCodeformintNo
StatusDescriptionformstringNo
ContentTypeformstringNo
DtoformObjectNo
UseBufferedStreamformboolNo
IsClosedformboolNo
KeepAliveformboolNo
HasStartedformboolNo
ItemsformDictionary<string, Object>No
IRequestPreferences Parameters:
NameParameterData TypeRequiredDescription
AcceptsGzipformboolNo
AcceptsDeflateformboolNo
IHttpFile Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
FileNameformstringNo
ContentLengthformlongNo
ContentTypeformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Reports/{ReportID}/PDF/Download HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'IHttpResult' using the custom 'csv' filter}Cannot create an instance of an interface.