API - Add Report

Ovation will send third party data which contains the report_id of the report that should be generated. The third party will generate the report and will call the following API to return the PDF to Ovation.

Using our REST API to Add Report

The Add Report request is an HTTP PUT call to the following urls:

Required data to from Ovation

The following data must be provided by Ovation in order to call the API.  Different values must be configured for staging and production

  • authorization token
  • report_id (used in URL)

Report Payload

"report": {
  "requisitionIdentifier": "string",
  "reportContent": "string"
}

Field name

Required

Description

requisitionIdentifier yes Requisition identifier report is associated with.
reportContent yes Serialized base64 encoded export of pdf document


Report Response

The Add Report API call can return the following possible responses:

Response code

Response body

201 “Indicating the report was successfully added” { "message": "Report successfully uploaded." }
401 “Indicating an authentication error”
422 “Validation error, indicating an error with the request contents” Will return the validation errors found.
e.g. "Report ID required", "Requisition not found""Report not found", or "Invalid Requisition for Report"
Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.