Request Report

All report times are based on UTC time.

The StatusSummary report will generate a report based on data available when the report is run.

The Breakage, Dormancy, NegativeBalance, and EODBalanceSummary reports will use one date input.

If no date is provided, they will default to the date 2 days prior to the current date.

All other reports will take 2 date inputs.

SecurityBearer

Request

path Parameters

version

required

string

query Parameters

report_name	string report name
program_guid	string <uuid> program guid
date_from	string <date-time> from date (optional)
date_to	string <date-time> to date (optional)
override_flag	string override flag (optional)
overwrite_flag	string overwrite flag (optional)

Responses

200

Returns the Report Guid

400

Bad request

401

Unauthorized

404

Report name not found

500

Server Error

get/api/{version}/reports

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"reference_id": "97c1ff22-6e4f-4821-b1d3-5236781d37b8",
"program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
"program_name": "string",
"ext_name": "string",
"status": "string",
"filename": "string",
"error": "string",
"rpt_lastgenerated": "2019-08-24T14:15:22Z"
}