Skip to main content
Version: 1.7.3

CancelSubmission

Cancels a submission by Submission Id.

POST Utility/CancelSubmission 
Run in Postman

Request Body

FieldTypeDescription
RecordIdsobject[]Contains the list of RecordIds for which you are requesting the pdf URLs
    RecordIdGuidUnique identifier of the return.

Request JSON

{
"SubmissionId": "4cae8529-278c-441f-84ae-f07b5f0c0f1b",
"RecordIds": [
{
"RecordId": "2684e4ee-5645-4ed2-9ccc-62132376e9ef"
}
]
}

Response Body

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code.
StatusMessagestringDetailed status message.
    SuccessRecordsobject[]Contains the successful cancel records.
        RecordIdGuidUnique identifier of the return.
        StatusstringStatus of the successfully cancelled record
    ErrorRecordsobject[]Contains the error records
        RecordIdGuidUnique identifier of the return.
        StatusstringStatus of the error record.
Errorsobject[]Shows detailed error information.
    CodestringReturns the validation error code.
    NamestringName of the validation error.
    MessagestringDescription of the validation error.
    TypestringType of validation error.

Response JSON

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

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SuccessRecords": [
{
"RecordId": "653e90de-4a99-438e-9fd6-46e903b27891",
"Status": "The ReturnId has been cancelled."
}
],
"ErrorRecords": null,
"Errors": null
}