Skip to main content
Version: 1.7.1

Status

Gets the status of the New Hire report records by Submission Id and Record Ids.

GET NewHireReport/Status

Request Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
RecordIdsGuid[]List of record Ids to get status.

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.
        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.

Request JSON

{   "SubmissionId": "f1ed3955-1b64-408c-a730-9008a192db3f",   "RecordIds": [       "1ea1e55c-7175-4539-882b-f856edab1b69"     ]}

Response JSON

{ "StatusCode": 200, "StatusName": "Ok", "StatusMessage": "Successful API call", "SubmissionId": "f1ed3955-1b64-408c-a730-9008a192db3f", "NHReports": {   "SuccessRecords": [     {       "Sequence": "1",       "RecordId": "1ea1e55c-7175-4539-882b-f856edab1b69",       "RecordStatus": "Transmitted",       "CreatedTs": "2019-07-26 07:51:16 -04:00",       "UpdatedTs": "2019-07-26 08:14:11 -04:00"     }   ],   "ErrorRecords": null }, "Errors": null}