CancelSubmission

Cancels a submission by Submission Id.

POST Utility/CancelSubmission 

Request Body

Field	Type	Description
RecordIds	object[]	Contains the list of RecordIds for which you are requesting the pdf URLs
RecordId	Guid	Unique identifier of the return.

Request JSON

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

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.
SuccessRecords	object[]	Contains the successful cancel records.
RecordId	Guid	Unique identifier of the return.
Status	string	Status of the successfully cancelled record
ErrorRecords	object[]	Contains the error records
RecordId	Guid	Unique identifier of the return.
Status	string	Status of the error record.
Errors	object[]	Shows detailed error information.
Code	string	Returns the validation error code.
Name	string	Name of the validation error.
Message	string	Description of the validation error.
Type	string	Type 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
}