API for push employee from other system to ZINGHR. Each API request require the token as an input which identifies the request and check if the required API is valid or not.


Overview


URL

https://portal.zinghr.com/2015/route/Integration/PushEmployees

Methods Supported

POST

Description

This API will create and update employees passed in Json format

 

Important Notes on API  :

  • · Employee Code, First Name, Date Of Birth, Date Of Joining is mandatory to create employee
  • · When employee create/update request is sent, below properties are checked for duplication 
    • Employee Code
    • Mobile Number
    • Email Id
    • PAN Number
  • · Employee Code is mandatory to update employee details
  • · When employee update request is sent, below properties are not updated in the system
    • Employee Code
    • Role
    • Attributes

   

 

Input


The following input fields are required to Push Employees to ZingHR.


SubscriptionName *

Name of account (max length =10)

Token*

For verification of the account and request.

 

Elements for Employee Collection: 


EmployeeCode*

Employee Code to be created in the system  (Mandatory for both to Add new employee or Update existing employee)

Salutation

Employee's salutation

FirstName*

Employee first name (mandatory in case of Adding new employee)

LastName

Employee last name

MiddleName

Employee middle name

FatherName

Employee father name

Email

Employee email Id

Gender

Employee gender, would be 1/0 

1 - Male

0- Female

Mobile

Employee mobile number

DateOfBirth*

Employee Date of birth (Mandatory in case of adding new employee)                                 Date format : yyyy-mm-dd

DateOfJoining*

Employee Date of joining (Mandatory in case of adding new employee)

Date format : yyyy-mm-dd

Dateofconfirmation

Employee Date of confirmation 

Date format : yyyy-mm-dd

PAN

Employee PAN number

AadhaarNumber

Employee Aadhaar Number

ReportingManagerCode

Reporting manager code in the system of the given employee

 

Response 


Message

Messages

Code

Codes

Errors

Error Collections

 

Elements of Errors Collection: 


EmployeeCode

Employee code for which some error is occurred  

Message

Error description specifying what exact error is occurred .

 

API Codes & Message: 


Code 1

Message : Success

Code : 3

Message : Invalid Token

Code : 4

Message : Internal Server Error

Code : 6

Message : Token Expired

 

 API URL:  ( ADD / MODIFY)


https://portal.zinghr.com/2015/route/Integration/PushEmployees


Input: 

{

  "SubscriptionName": "CompanyCode",

  "Token": "77a288XXXXXXXXXXXXX0fd0a",

  "Employees": [

    {

      "EmployeeCode":"testEmp_04",

      "Salutation": "Mr.",

      "FirstName": "Test",

      "MiddleName": "R",

      "LastName": "Saxena",

      "Email": "testEmp_04@test.com",

      "Gender": "1",

      "Mobile": "77XXXXXXX1",

      "DateOfBirth": "1988-06-12",

      "DateOfJoining": "2019-05-12",

      "Dateofconfirmation":"2019-11-12",

      "PAN":"AIMXXXXXH",

      "AadhaarNumber":"123456789012",

      "ReportingManagerCode":"ADMIN"

}

  ]

}