Search

Reports - Output Types and Formatting

Every report adheres to a strict standard to ensure accuracy and consistency in data delivery. Despite variations in content, the integrity of the data remains a top priority. This commitment to excellence guarantees the reliability of the information presented. The standardized formatting acts as a reliable guide through the data, making it easier to navigate. As you explore the reporting pages, you will uncover the distinctive parameters for those reports.

Endpoints

All Reports use the same endpoint to access.

Url	Type
/ActiveReports/GetReport.aspx	CGI

Output Parameters

In a Direct type of response, the output parameters will only be encoded as HTTP Headers. In other response types the output parameters will be returned in the message and as HTTP Headers.

Name	Description	Example
Message	A simple message to describe the result of the request. It can also be an error message.	“Success”
Method	The Action you are requesting.	“Token”, “ReportList”, “Report”
Severity	A value between 0 and 9. Zero being a success and 9 being a sever error.	0
Success	A True/False value indicating the success of the call.	True
Version	The version of the API call. Generally if you request a version, we will honor the version you requested in the response.	1.4.2.24
Token	The security token related to your credentials, expiration, and configuration. This is a Base64 Encoded string. It is variable length and depending on the information included it can be very long.	qXDzhFGifK04IRbBFROx5Rx84

Output Types and Format

Report Formats

Binary	String
Word	HTML
Excel	CSV (With and Without Columns)
PDF	Text (space delimited)
	XML
	JSON

Return Types

Enumeration	Description
XML	Envelope is XML, internal report data is in a CData section in XML format
XML_HTML	Envelope is XML, internal report data is in a CData section in HTML format
XML_CSV	Envelope is XML, internal report data is in a CData section in CSV format
XML_CSVWithColumns	Envelope is XML, internal report data is in a CData section in CSV format with column headers included
XML_Text	Envelope is XML, internal report data is in a CData section in space delimited format
XML_Word	Envelope is in XML, internal report data is in a CData section in Microsoft Word binary format (base 64 encoded)
XML_Excel	Envelope is in XML, internal report data is in a CData section in Microsoft Excel binary format (base 64 encoded)
XML_PDF	Envelope is in XML, internal report data is in a CData section in Microsoft PDF binary format (base 64 encoded)
JSON	Envelope is JSON, internal report data is in the ReportData value section in JSON format
JSON_HTML	Envelope is JSON, internal report data is in the ReportData value section in HTML format
JSON_CSV	Envelope is JSON, internal report data is in the ReportData value section in CSV format
JSON_CSVWithColumns	Envelope is JSON, internal report data is in the ReportData value section in CSV format with column headers included
JSON_Text	Envelope is JSON, internal report data is in the ReportData value section in space delimited format
JSON_Word	Envelope is JSON, internal report data is in the ReportData value section in Microsoft Word binary format (base 64 encoded)
JSON_Excel	Envelope is JSON, internal report data is in the ReportData value section in Microsoft Excel binary format (base 64 encoded)
JSON_PDF	Envelope is JSON, internal report data is in the ReportData value section in PDF binary format (base 64 encoded)
DirectHTML	No envelope and HTML is returned as a stream
DirectXML	No envelope and XML is returned as a stream
DirectJSON	No envelope and JSON is returned as a stream
DirectText	No envelope and space deliminted text is returned as a stream
DirectCSV	No envelope and CSV is returned as a stream
DirectCSV	No envelope and CSV with headers is returned as a stream
DirectWord	No envelope and Word is returned as a stream
DirectExcel	No envelope and Excel is returned as a stream
DirectPDF	No envelope and PDF is returned as a stream

Examples

Responses

Xml

The outer envelope is XML and the report data element will contain the actual report data and will be in string or
binary format (Base 64 encoded)

<Response Method="Report" Version="1.4.2.24" Severity="0" Success="True">
<Message></Message>
<ReportData></ReportData>
</Response>

JSON

{
"Method": "Report",
"Version": "1.4.2.24",
"Severity": "0",
"Success": "True",
"Message": "Success",
"ReportData": ""
}