Transmit
Transmits Online 94X PIN request records to the State after validation.
GET Online94xPINRequest/Transmit
Request Params
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
Request Params
"Online94xPINRequest/Transmit?SubmissionId=4e157f47-9c26-4a56-8a38-567eebf05163"
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. |
SubmissionId | Guid | Unique identifier of a submission. |
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. |
Online94xPINRecords | object | Pulls the Online 94X PIN request records with Success and Error statuses. |
SuccessRecords | object[] | It will show the detailed information about the success status of Form 941 Records |
Sequence | string | A unique number given by an inbound application to identify failed records. |
RecordId | Guid | Unique identifier of a record. |
RecordStatus | string | Returns the status of the records. |
CreatedTs | string | Date and time of return created. |
UpdatedTs | string | Date and time of return updated. |
ErrorRecords | object[] | It will show the detailed information about the error status of Form 941 Records |
Sequence | string | A unique number given by an inbound application to identify failed records. |
RecordId | Guid | Unique identifier of a 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",
"SubmissionId": "4e157f47-9c26-4a56-8a38-567eebf05163",
"Errors": null,
"Online94xPINRecords": {
"SuccessRecords": [
{
"Sequence": null,
"RecordId": "162684c0-6d80-4f05-8df2-edc26e2efd90",
"RecordStatus": "Transmitted",
"CreatedTs": "2019-08-02 04:08:20 -04:00",
"UpdatedTs": "2019-08-02 04:10:58 -04:00"
}
],
"ErrorRecords": null
}
}