Skip to main content
Version: 1.7.3

Status

Gets the status of the Online 94X PIN request records by Submission Id and Record Ids.

GET Online94xPINRequest/Status 
Run in Postman

Request Params

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission

Request Params

"Online94xPINRequest/Status?SubmissionId=144b8a27-5802-46c5-b1f6-0510026ca46a"

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.
Online94xPINRecordsobjectPulls the Online 94X PIN request records with Success and Error statuses.
    SuccessRecordsobject[]It will show the detailed information about the success status of Form 941 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 941 Records
        SequencestringA unique number given by an inbound application to identify failed records.
        RecordIdGuidUnique identifier of a 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.
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": "144b8a27-5802-46c5-b1f6-0510026ca46a",
"Online94xPINRecords": {
"SuccessRecords": [
{
"Sequence": "",
"RecordId": "e4b666b2-54a0-4753-92e0-d94d7a2a6ae0",
"RecordStatus": "Created",
"CreatedTs": "2019-08-02 03:40:42 -04:00",
"UpdatedTs": "2019-08-02 03:40:42 -04:00"
}
],
"ErrorRecords": null
},
"Errors": null
}