Skip to main content
Version: 1.7.3

GetPdf

GET Form5498ESA/GetPDF 
Run in Postman

Request Params

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission.
RecordIdsGuid[]Optional Unique identifier of a records.

Request Params

"Form5498ESA/GetPDF?SubmissionId=f1192772-6b1f-4bfc-8766-dab1a4b7920d&RecordIds=22cc3785-fcb2-4400-80b2-4772ec4edac8"

Response Body

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code
StatusMessagestringDetailed status message
SubmissionIdGuidUnique identifier of a submission
Form5498ESARecordsobject[]Collection of Form 5498 ESA records for which the PDF will be successfully delivered
    RecordIdguidUnique identifier of a record
    MessagestringProvides additional information regarding the PDF delivery.
Errorsobject[]Shows detailed error information
    IdstringReturns the validation error Id.
    NamestringName of the validation error.
    MessagestringDescription of the validation error

Response JSON

Success Response - This is a sample response for successful API requests.

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "f1192772-6b1f-4bfc-8766-dab1a4b7920d",
"Form5498ESARecords": [
{
"RecordId": "22cc3785-fcb2-4400-80b2-4772ec4edac8",
"Message": "We've successfully received your request to generate PDF. You will be notified with the URL to download the PDF."
}
],
"Errors": null
}