GetPdf

GET Form5498ESA/GetPDF 

Request Params

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission.
RecordIds	Guid[]	Optional Unique identifier of a records.

Request Params

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

Response Body

Field	Type	Description
StatusCode	number	Returns the HTTP status codes like 200,300 etc.
StatusName	string	Name of the status code
StatusMessage	string	Detailed status message
SubmissionId	Guid	Unique identifier of a submission
Form5498ESARecords	object[]	Collection of Form 5498 ESA records for which the PDF will be successfully delivered
RecordId	guid	Unique identifier of a record
Message	string	Provides additional information regarding the PDF delivery.
Errors	object[]	Shows detailed error information
Id	string	Returns the validation error Id.
Name	string	Name of the validation error.
Message	string	Description 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
}