Skip to main content
Version: 1.7.3

GetPdf

GET Form5498/GetPDF 
Run in Postman

Request Params

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

Request Params

"Form5498/getpdf?SubmissionId=eeee66d3-5291-4675-828a-f153616e99ca&RecordId=c0bfc6ce-9c6e-4031-8ab5-3d1099e1c0e7"

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
Form5498Recordsobject[]Collection of Form 5498 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": "eeee66d3-5291-4675-828a-f153616e99ca",
"Form5498Records": [
{
"RecordId": "c0bfc6ce-9c6e-4031-8ab5-3d1099e1c0e7",
"Message": "We've successfully received your request to generate PDF. You will be notified with the URL to download the PDF."
}
],
"Errors": null
}