Get Report Token


Description

This function generates a one time use token with a 5 minute expiration and returns a URL containing the token which can be used as an HTTP redirect allowing a user to pull a report without signing into the system.

Authentication

Requires HTTP BASIC authentication.

HTTP Methods

Accepts GET and POST requests

URI

/api/debtors/{ID}/report.json

Path Variables

Name Required/Optional Description Validation
ID required The UUID of the debtor or the account number Debtor UUID should exist in the system.

Parameters

Name Required/Optional Description Validation
end optional The end date of the report.The default is the current month The date parameter must be formatted like this: end=MM/yyyy For example, January, 2012 is 01/2012. The end date must be after the start date
start optional The start date of the report. The default is 12 months before the current month The date parameter must be formatted like this: end=MM/yyyy For example, January, 2012 is 01/2012. The start date must be before today's date or the specified end date
type optional The type of the report which can be HTML or FULL_REPORT_PDF or SCRUBBED_REPORT_PDF. The default is HTML Valid values are HTML or FULL_REPORT_PDF or SCRUBBED_REPORT_PDF
creditor optional The UUID of the creditor. Any user mapped to more than one creditor will have Default Creditor in an alphabetical order. If no Creditor is passed in the API request then the results for the Credit Status will be based upon the settings of the Default Creditor Creditor UUID should exist in the system.

Curl Example

Sample Requests

curl -u apiuser:test "https://www.factorsnetwork.com/api/debtors/e6aaa036-2121-d11d-dd33-869ffac113be/report.json"
curl -u apiuser:test "https://www.factorsnetwork.com/api/debtors/e6aaa036-2121-d11d-dd33-869ffac113be/report.json?start=01/2011&end=01/2012&type=HTML&creditor=ff5ac510-5674-2111-d1dd-2bda1f96f82f"
curl -u apiuser:test "https://www.factorsnetwork.com/api/debtors/4AAA56/report.json?creditor=e6aaa036-2121-d11d-dd33-869ffac113be"

Response

   {"url":"https://www.factorsnetwork.com/credit/api/reports/627bcd06-3231-322d-bc45-c0726ff426da"}
Note: Visiting the URL returned in a web browser will display or save the requested report.