Skip to main content
Version: 1.7.0

Validate

Runs business and data validation checks for the 943 forms already created in API. You must use the Submission ID of the return to Validate.

GET Form943/Validate 
Run in Postman

Request Params

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
RecordIdsGuid[]Optional Unique identifier of a record

Request Params

"Form943/Validate?SubmissionId=f2fee2f8-74bf-4e1d-9239-399e76929475&RecordIds=ed6bc24b-189d-419b-9224-2dd2bf3b7467"

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.
Form943RecordsobjectPulls the Form 943 records with Success and Error statuses.
    SuccessRecordsobject[]It will show the detailed information about the success status of Form 943 Records.
        SequencestringA unique number given by an inbound application to identify failed records.
        RecordIdGuidUnique identifier of a record.
        RecordStatusstringReturns the status of the records.
        CreatedTsstringDate and time of return created.
        UpdatedTsstringDate and time of return updated.
    ErrorRecordsobject[]It will show the detailed information about the error status of Form 943 Records.
        RecordIdGuidUnique identifier of a record.
        SequencestringA unique number given by an inbound application to identify failed records.
        Errorsobject[]Shows detailed error information.
            CodestringReturns the validation error code.
            NamestringName of the validation error.
            MessagestringDescription of the validation error.
            TypestringType of validation error.
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",
"SubmissionId": "f2fee2f8-74bf-4e1d-9239-399e76929475",
"Form943Records": {
"SuccessRecords": [
{
"Sequence": "",
"RecordId": "ed6bc24b-189d-419b-9224-2dd2bf3b7467",
"RecordStatus": "Created",
"CreatedTs": "2020-02-02 03:06:07 -04:00",
"UpdatedTs": "2020-02-02 03:46:54 -04:00"
}
],
"ErrorRecords": []
},
"Errors": null
}