Skip to main content
Version: 1.7.0

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
SubmissionIdGuidUnique identifier of a submission.

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.
SubmissionIdGuidUnique identifier of a submission.
StatusstringForm 940 records success and error status
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

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "4d7a31d9-6387-4c67-aa54-769465e6e551",
"Status": "CANCELLED",
"Errors": null
}