Validate

Runs business and data validation checks for New Hire report records.

GET NewHireReport/Validate

Request Body

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission
RecordIds	Guid[]	List of record Ids to be transmitted.

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.
NHReports	object	Pulls the New Hire report records with Success and Error statuses.
SuccessRecords	object[]	It will show the detailed information about the success status of New Hire Report 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.
EmployeeRecords	string	Return status details like Created, Transmitted, Accepted, Rejected.
Sequence	string	A unique number given by an inbound application to identify failed records.
EmployeeUId	Guid	Unique identifier of an Employee.
Status	string	Returns the status of the Employee details.
CreatedTs	DateTime	Date and time of return created.
UpdatedTs	DateTime	Date and time of return updated.
ErrorRecords	object[]	It will show the detailed information about the error status of New Hire Report 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.
EmployeeErrorRecords	object[]	Return status details like Created, Transmitted, Accepted, Rejected.
Sequence	string	A unique number given by an inbound application to identify failed records.
EmployeeUId	Guid	Client Record Identifier.
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.
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.

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": "Success",
       "EmployeeRecords": [
         {
           "Sequence": "1",
           "EmployeeUId": "1f176e11-dcea-4b11-8ce9-8952c098223c",
           "Status": "Success"
         }
       ],
       "CreatedTs": "7/26/2019 7:51:16 AM",
       "UpdatedTs": "7/26/2019 7:51:16 AM"
     }
   ],
   "ErrorRecords": null
 },
 "Errors": null
}