Merge Report | Advance BSA
This service is used for merging two or more reports.
This API uses the reference IDs to fetch and merge two or more reports of the same type. Only homogeneous reports can be merged.
The authorization header in the request must include the access token obtained before this API can be consumed.
The API is hit by passing reference IDs generated by the create request API. API returns a reference id which can be used in fetch the merged reports
Need to pass follow information:
- reference IDs to be merged
PARAMETER NAME | REQUIRED/OPTIONAL | DESCRIPTION |
Authorization | REQUIRED | Contains the id parameter returned from the login step |
Content-Type | REQUIRED | application/json |
referenceIds | REQUIRED | List of strings containing reference IDs |
| | |
| | |
PARAMETER NAME | DESCRIPTION |
result.referenceId | this reference Id can be used in fetch data API |
result.message | message containing request output |
The API endpoint can return the following response codes:
Response Code | Description | Example Input (Error Scenario) | Example Output (Error Scenario) |
200 | The request was processed successfully. | NA | NA |
400 | The request was not processed successfully. An error message is included in the response body. | { "referenceIds": [] } | { "error": { "name": "error", "message": "\"referenceIds\" must contain at least 2 items", "status": 400, "reason": "VALIDATION_REQUEST", "type": "OK", "statusCode": 200 } } |
409 | The request could not be processed due to some error in upstream. | NA | { "error": { "name": "error", "message": "Error in fetching data", "status": 409, "reason": "UPSTREAM DOWN", "type": "Conflict", "statusCode": 409 } }} |
Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.
You can reach out to us at [email protected].