Upload ZIP Report
Request via this endpoint to upload a zip report using multipart/form-data.
HTTP Method: POST
Request URL: https://api.expertsys.com/v1/reports
HEADER: Two header fields must be set (use uppercase):
| Key |
Value |
Mandatory |
| EMAIL |
User email |
Yes |
| PASSWORD |
User password |
Yes |
You must be a registered user !
BODY: The body should contain only one key / value pair, used for the json file.
| Key |
Value |
Mandatory |
| FILE |
JSON file |
Yes |
RESPONSE: Http resonse status code must be 200. If so then responses are
application/json content type.
{
"success": true,
"message": "Report uploaded"
}
On failure, success will be false and message will describe the error.
Important: The filename must be unique for every report.
Get Report List
Request via this endpoint to get a list of reports waiting to go into production.
HTTP Method: GET
Request URL: https://api.expertsys.com/v1/reports
HEADER: Two header fields must be set (use uppercase):
| Key |
Value |
Mandatory |
| EMAIL |
User email |
Yes |
| PASSWORD |
User password |
Yes |
You must be a registered user !
RESPONSE: Http resonse status code must be 200. If so then responses are
application/json content type.
{
"success": true,
"message": [{
"report_id": number,
"report_upload_unixtime": number,
"report_file_name": "string",
"report_file_size": number,
"report_uploaded_by": "string"
}]
}
On failure, success will be false and message will describe the error.
Download Report
Request via this endpoint to download a report. Reports are only available for download if
not in production.
HTTP Method: GET
Request URL: https://api.expertsys.com/v1/reports?report_id={report_id}
HEADER: Two header fields must be set (use uppercase):
| Key |
Value |
Mandatory |
| EMAIL |
User email |
Yes |
| PASSWORD |
User password |
Yes |
You must be a registered user !
RESPONSE: Http resonse status code must be 200.
On success: Response header content type is
application/octet-stream. Report file precisely as it was uploaded.
On failure: Response header content type is
application/json.
{
"success": false,
"message": "error description"
}
Remove Report (Expertsys Only)
Request via this endpoint to remove a report (insert to production)
HTTP Method: Delete
Request URL: https://api.expertsys.com/v1/reports?report_id={report_id}
HEADER: Two header fields must be set (use uppercase):
| Key |
Value |
Mandatory |
| EMAIL |
User email |
Yes |
| PASSWORD |
User password |
Yes |
You must be a registered user !
RESPONSE: Http resonse status code must be 200. If so then responses are
application/json content type.
{
"success": true,
"message": "Report removed"
}
On failure, success will be false and message will describe the error.
Important: Once a report is removed it can not longer be downloaed and will not appear in
report list.
API Client (NodeJS):
You can try out our api using our api client:
download