Skip to main content
Version: 1.7.1

Transmit

Transmits New Hire report records to the State after validation.

POST NewHireReport/Transmit

Request Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
RecordIdsGuid[]List of record Ids to be transmitted.

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.
NHReportsobjectPulls the New Hire report records with Success and Error statuses.
    SuccessRecordsobject[]It will show the detailed information about the success status of New Hire Report Records.
        SequencestringA unique number given by an inbound application to identify failed records.
        RecordIdGuidUnique identifier of a record.
        RecordStatusstringReturns the status of the records.
        EmployeeRecordsstringReturn status details like Created, Transmitted, Accepted, Rejected.
            SequencestringA unique number given by an inbound application to identify failed records.
            EmployeeUIdGuidUnique identifier of an Employee.
            StatusstringReturns the status of the Employee details.
        CreatedTsDateTimeDate and time of return created.
        UpdatedTsDateTimeDate and time of return updated.
    ErrorRecordsobject[]It will show the detailed information about the error status of New Hire Report 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.
        EmployeeErrorRecordsobject[]Return status details like Created, Transmitted, Accepted, Rejected.
            SequencestringA unique number given by an inbound application to identify failed records.
            EmployeeUIdGuidClient Record Identifier.
            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.

Request JSON

{   "SubmissionId": "31eb9b80-a935-4204-b32c-14db8d99a57e",   "RecordIds": [       "2ffde35c-c885-45c6-ab48-424a89c838ed"          ]}

Response JSON

{   "StatusCode": 200,   "StatusName": "Ok",   "StatusMessage": "Successful API call",   "SubmissionId": "31eb9b80-a935-4204-b32c-14db8d99a57e",   "NHReports": {       "SuccessRecords": [           {               "Sequence": "1",               "RecordId": "2ffde35c-c885-45c6-ab48-424a89c838ed",               "RecordStatus": "TRANSMITTED",               "EmployeeRecords": [                   {                       "Sequence": "1",                       "EmployeeUId": "b20c15ce-1ff5-44aa-a470-9876102736e4",                       "Status": "TRANSMITTED"                   },                   {                       "Sequence": "2",                       "EmployeeUId": "6ee31144-c0db-48da-a82b-f798342e6e58",                       "Status": "TRANSMITTED"                   }               ],               "CreatedTs": "8/2/2019 8:36:04 AM",               "UpdatedTs": "8/2/2019 9:38:24 AM"           }       ],       "ErrorRecords": null   },   "Errors": null}