- Created by T E Gautham , last modified on Dec 17, 2024
You are viewing an old version of this content. View the current version.
Compare with Current View Version History
« Previous Version 18 Current »
1 General
The JSON Schema API presents the input template for adding new employee master data to and editing the master data of existing employees in HRWorks. Each customer database in HRWorks has a unique set of masters with regard to employee data. Hence, it is imperative that the JSON schema API is conformed to while sending employee data to HRWorks from a third-party system.
1.1 Authentication
Your API calls must contain the API key for the purpose of authentication.
Parameter | Description |
|---|---|
key | Please contact the HRWorks administrator in your organization for the API key. |
You can generate the API key for your organization yourself.
1.2 Endpoint
https://hinote.in/hrworks/api/v1/employeeJsonSchema?key=<customer_api_key>
You need to use https in your API call.
Please note that the API key must be appended with the URL as a request parameter.
2. Response
If the JSON Schema API call is successful, the API shall return an input template for the addEmployee and editEmployee API. A typical example of the response is as follows.
Expand source
{
"title": "Employee JSON Schema in HRWorks",
"description": "Employee JSON Schema for HRWorks Employee Input API for xyzco",
"createdAt": "2021-07-23T05:38:09.000+000",
"type": "object",
"properties": {
"employeeId": {
"type": "string",
"description": "Employee Id",
"required": "true for add employee action"
},
"firstName": {
"type": "string",
"description": "Employee First Name",
"required": "true for add employee action"
},
"middleName": {
"type": "string",
"description": "Employee Middle Name"
},
"lastName": {
"type": "string",
"description": "Employee Last Name"
},
"dateOfBirth": {
"type": "string",
"description": "Employee date of birth",
"format": "date",
"required": "true for add employee action"
},
"nationality": {
"type": "string",
"description": "Employee nationality",
"required": "true for add employee action",
"enum": [
"Bahrainian",
"Omani",
"Kuwaiti",
"Qatari",
"Nepalese",
"Malaysian",
"Australian",
"Sri Lankan",
"American",
"British",
"French",
"Canadian",
"Saudi Arabian",
"Emirati",
"Indian"
]
},
"fatherName": {
"type": "string",
"description": "Father's name of employee",
"required": "true, if unmarried and for add employee action"
},
"maritalStatus": {
"type": "string",
"description": "Marital status of employee",
"required": "true for add employee action",
"enum": [
"M",
"S",
"Married",
"Single",
"Unmarried",
"Bachelor"
]
},
"spouseName": {
"type": "string",
"description": "Name of employee spouse",
"required": "true, if married and for add employee action"
},
"gender": {
"type": "string",
"description": "gender",
"required": "true for add employee action",
"enum": [
"M",
"F",
"T",
"Male",
"Female",
"Transgender"
]
},
"salutation": {
"type": "string",
"description": "Employee salutation",
"required": "true for add employee action",
"enum": [
"Mx",
"Sir",
"Dr",
"Mrs",
"Ms",
"Miss",
"Mr"
]
},
"bloodGroup": {
"type": "string",
"description": "Employee blood group",
"enum": [
"A Negative",
"A Positive",
"A1 B Positive",
"A1 Negative",
"A1 Positive",
"A1B Negative",
"A1B Positive",
"A2B Negative",
"AB Negative",
"AB Positive",
"B Negative",
"B Positive",
"O Negative",
"O Positive"
]
},
"bankBranch": {
"type": "string",
"description": "Bank name / Bank branch",
"enum": [
"Axis Bank/Chennai",
"Axis Bank/Anna Nagar",
"Axis Bank/Garia",
"Axis Bank/Ramapuram",
"Axis Bank/Gachibowli"
]
},
"bankAccountNo": {
"type": "string",
"description": "Bank account number"
},
"nameInBankAccount": {
"type": "string",
"description": "Name as in bank account"
},
"dateOfJoining": {
"type": "string",
"description": "Date of joining",
"format": "date",
"required": "true for add employee action"
},
"dateOfConfirmation": {
"type": "string",
"description": "Date of confirmation",
"format": "date"
},
"pfJoinDate": {
"type": "string",
"description": "PF Join Date",
"format": "date"
},
"userId": {
"type": "string",
"description": "User Id for the emoloyee in HRWorks"
},
"password": {
"type": "string",
"description": "Password to log into HRWorks"
},
"tpg": {
"type": "string",
"description": "Tax processing group",
"required": "true for add employee action",
"enum": [
"CPG",
"TPG"
]
},
"priorExperienceMonths": {
"type": "integer",
"description": "Prior Experience Months"
},
"priorExperienceYears": {
"type": "integer",
"description": "Prior Experience Years"
},
"statutoryId": {
"type": "object",
"properties": {
"pan": {
"description": "Permanent Account Number",
"type": "string",
"pattern": "[a-zA-Z]{3}[pP][a-zA-Z][0-9]{4}[a-zA-Z]"
},
"pfno": {
"description": "Provident Fund Number",
"type": "string"
},
"esino": {
"description": "Employee State Insurance Number",
"type": "string"
},
"uan": {
"description": "Universal Account Number ",
"type": "string",
"pattern": "[0-9]{12}"
}
}
},
"dependant": {
"type": "array",
"items": {
"type": "object",
"properties": {
"relationship": {
"description": "Relationship with the employee",
"type": "string",
"required": true,
"enum": [
"Mother",
"Father",
"Spouse",
"Son",
"Daughter"
]
},
"salutation": {
"description": "Salutation of the dependant",
"type": "string",
"required": true,
"enum": [
"Mx",
"Sir",
"Dr",
"Mrs",
"Ms",
"Miss",
"Mr"
]
},
"firstName": {
"description": "First name of the dependant",
"type": "string",
"required": true
},
"middleName": {
"description": "Middle name of the dependant",
"type": "string"
},
"lastName": {
"description": "Last name of the dependant",
"type": "string"
},
"dateOfBirth": {
"description": "Date of birth of the dependant",
"type": "string",
"format": "date",
"required": true
}
}
}
},
"designation": {
"description": "Value can be string for add employee action. If string, refer to the id property in the items",
"type": [
"array",
"string"
],
"required": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Designation Id",
"type": "string",
"required": true,
"enum": [
"Admin Exec",
"Administrator",
"Analyst",
"Associate Software Engineer",
"Business Analyst",
"Business Development - Executive",
"Business Intelligence DB Analyst",
"C.O.O.",
"Client Services Manager",
"Communication Coordinator",
"Consultant",
"Data Analyst",
"Database Engineer",
"DBA & BI Specialist",
"Director ",
"Executive - Call Centre",
"Executive - HR",
"Executive - Technology Operations",
"Facility Manager",
"Front Office Associate",
"Graduate - Trainee",
"Graphics Designer",
"Housekeeping Staff",
"HR Associate",
"Inside Sales Specialist",
"IT - Network & Security Admin",
"IT Support - Server & Storage Admin",
"IT Support - Server Administrator",
"Lead Analyst",
"Manager - Client Relations",
"Manager - Operation Support & QA",
"Manager Tech Suppt ",
"Manager-Testing",
"Operations Administrator",
"Proj. Manager & Solutions Architect",
"Project Lead",
"Project Manager",
"Quality Analyst - Lead",
"Quality Analytics Lead",
"Quality Assurance Manager",
"Security Administrator",
"Senior Analyst",
"Senior Data Analyst",
"Senior Data Architect",
"Senior Executive - Quality Control",
"Senior Graphics Designer",
"Senior HR Executive",
"Senior Product Manager",
"Senior Project Manager",
"Senior QA Executive",
"Senior Sharepoint Administrator",
"Senior Software Engineer",
"Senior Software Engineer - Testing",
"Senior Software Engineer-IT Support",
"Senior System Analyst",
"Senior System Engineer",
"Senior Test Engineer",
"Server Administrator",
"Service Now Administrator",
"Software Engineer",
"Software Engineer - IT Support",
"Software Engineer - Testing",
"Software Engineer - Trainee",
"Software Engineer-Testing -Trainee",
"Software Engineer-Testing-Trainee",
"Software Test Analyst",
"Sr Sharepoint Admin - IT Support",
"Sr Software Engineer - IT Support",
"Sr. Project Mgr - IT Infrastructure",
"Sr.Project Mgr - IT Infrastructure",
"Sr.System Engineer-Data Base Admin",
"Substaff",
"SW Test Analyst ",
"System Analyst ",
"System Analyst - Server Admin",
"System Engineer",
"System Engineer - Database Admin",
"System Engineer - Network Admin",
"System Engineer - Operations",
"System Engineer -Security Admin",
"Team Lead",
"Team Lead - Business Operations",
"Technical Lead & Project Manager",
"Technical Team Lead & Project Mgr",
"Technology Expert",
"Trainee",
"Trainee - Data Analyst",
"Trainee Executive - Operation"
]
},
"fromDate": {
"description": "From Date",
"type": "string",
"format": "date",
"required": true
}
}
}
},
"manager": {
"description": "Value can be string for add employee action. If string, refer to the employeeId property in the items",
"type": [
"array",
"string"
],
"items": {
"type": "object",
"properties": {
"employeeId": {
"description": "Employee Id of Manager",
"type": "string",
"required": true
},
"fromDate": {
"description": "From Date",
"type": "string",
"format": "date",
"required": true
}
}
}
},
"employeeType": {
"description": "Value can be string for add employee action. If string, refer to the id property in the items",
"type": [
"array",
"string"
],
"required": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "EmployeeType Id",
"type": "string",
"required": true,
"enum": [
"O",
"PM",
"PR",
"PT",
"TR"
]
},
"fromDate": {
"description": "From Date",
"type": "string",
"format": "date",
"required": true
}
}
}
},
"status": {
"description": "Value can be string for add employee action. If string, refer to the id property in the items",
"type": [
"array",
"string"
],
"required": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Status Id",
"type": "string",
"required": true,
"enum": [
"Deceased",
"Employed",
"Payment On Hold",
"Relieved (Disabled)",
"Resigned - On Notice",
"Resigned - Relieved",
"Suspended",
"Terminated - On Notice",
"Terminated - Relieved"
]
},
"fromDate": {
"description": "From Date",
"type": "string",
"format": "date",
"required": true
},
"processPayroll": {
"type": "boolean",
"description": "Process payroll"
},
"processPayment": {
"type": "boolean",
"description": "Process payment"
},
"reasonForLeaving": {
"type": "String",
"description": "Reason for leaving"
}
}
}
},
"division": {
"description": "Value can be string for add employee action. If string, refer to the id property in the items",
"type": [
"array",
"string"
],
"required": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Division Id",
"type": "string",
"required": true,
"enum": [
"Administration",
"Analytics",
"Application Development",
"Ashley",
"Ashley IT",
"Database",
"Graphics Design",
"Human Resources",
"Infrastructure",
"IT",
"Management",
"Retail",
"Sales",
"Tech Support",
"Testing"
]
},
"fromDate": {
"description": "From Date",
"type": "string",
"format": "date",
"required": true
}
}
}
},
"workLocation": {
"description": "Value can be string for add employee action. If string, refer to the id property in the items",
"type": [
"array",
"string"
],
"required": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "WorkLocation Id",
"type": "string",
"required": true,
"enum": [
"Chennai"
]
},
"fromDate": {
"description": "From Date",
"type": "string",
"format": "date",
"required": true
}
}
}
},
"shift": {
"description": "Value can be string for add employee action. If string, refer to the code property in the items",
"type": [
"array",
"string"
],
"items": {
"type": "object",
"properties": {
"code": {
"description": "Shift Code",
"type": "string",
"required": true,
"enum": [
"Shift 1",
"Shift 2",
"Shift 3",
"Shift C",
"Shift A ",
"Shift B",
"Flexi Shift"
]
},
"fromDate": {
"description": "From Date",
"type": "string",
"format": "date",
"required": true
}
}
}
},
"contactAddress": {
"type": "array",
"items": {
"type": "object",
"properties": {
"addressType": {
"description": "Address Type",
"type": "string",
"required": true,
"enum": [
"Current Address"
]
},
"addressLine1": {
"description": "Address Line 1",
"type": "string",
"required": true
},
"addressLine2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string",
"required": true
},
"state": {
"description": "Valid state or province code for the specific country",
"type": "string",
"required": true
},
"postalCode": {
"description": "Postal or zip code",
"type": "string",
"required": true
},
"country": {
"description": "2 or 3 letter ISO code for a country",
"type": "string",
"required": true
},
"isPrimary": {
"description": "True if primary address",
"type": "boolean",
"default": false
}
}
}
},
"contactEmail": {
"type": "array",
"items": {
"type": "object",
"properties": {
"emailType": {
"description": "Email Type as defined in HRWorks",
"type": "string",
"required": true,
"enum": [
"email"
]
},
"emailId": {
"description": "Email Id",
"type": "string",
"required": true,
"format": "email"
},
"isPrimary": {
"description": "True if primary email address",
"type": "boolean",
"default": false
}
}
}
},
"contactNo": {
"type": "array",
"items": {
"type": "object",
"properties": {
"phoneType": {
"description": "Phone type as defined in HRWorks",
"type": "string",
"required": true,
"enum": [
"Mobile"
]
},
"phoneNo": {
"description": "Contact number",
"type": "string",
"required": true
},
"isPrimary": {
"description": "True if primary contact number",
"type": "boolean",
"default": false
}
}
}
},
"other.ePS_Contribution": {
"description": "EPS_Contribution",
"type": "string",
"required": "true for add employee action",
"enum": [
"Yes",
"No",
"Determine"
]
},
"other.disabled": {
"description": "Value can be boolean for add employee action. If boolean, refer to the value property in the items",
"type": [
"array",
"boolean"
],
"items": {
"type": "object",
"properties": {
"value": {
"type": "boolean",
"required": true
},
"fromDate": {
"description": "From Date",
"type": "string",
"format": "date",
"required": true
}
}
}
},
"other.isSeniorMgr": {
"description": "Is Senior Mgr",
"type": "boolean"
},
"other.employeeRole": {
"description": "Value can be string for add employee action. If string, refer to the value property in the items",
"type": [
"array",
"string"
],
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"required": true,
"enum": [
"Data update specialist",
"IT Support",
"Sr AX Developer",
"Sr RPG Developer",
"DB Developer",
"Java Developer",
"Sr Business Analyst",
"Sr Tester",
"DBA",
"Junior",
"Sr Data Analyst",
"Sr UI Designer",
"DotNet Developer",
"Project Lead",
"Sr DB Developer",
"Sr UI Developer",
"EDI Developer",
"Project Manager",
"Sr DotNet Developer",
"Tester",
"Admin",
"GUI Design",
"R&D",
"Sr EDI Developer",
"UI Developer",
"Business Analyst",
"HR",
"RPG Developer",
"Sr HR",
"Data Analyst",
"IOS Developer",
"Service Now Developers",
"Sr Java Developer"
]
},
"fromDate": {
"description": "From Date",
"type": "string",
"format": "date",
"required": true
}
}
}
},
"other.revisionMonth": {
"description": "Revision Month",
"type": "string",
"enum": [
"April",
"October"
]
},
"other.project": {
"description": "Value can be string for add employee action. If string, refer to the value property in the items",
"type": [
"array",
"string"
],
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"maxlength": 50,
"required": true,
"enum": [
"A",
"B"
]
},
"fromDate": {
"description": "From Date",
"type": "string",
"format": "date",
"required": true
}
}
}
},
"other.totalExpasofApr2016": {
"description": "Total Exp as of Apr-2016",
"type": "string"
},
"skills.primaryskills": {
"description": "Primary skills",
"type": "string"
},
"payPackage": {
"description": "Configure pay/deduction components. For single pay package, use object type instead of array. For object type, refer to properties inside items.",
"type": [
"array",
"object"
],
"items": {
"type": "object",
"properties": {
"fromDate": {
"description": "From Date",
"type": "string",
"format": "date",
"required": true
},
"action": {
"description": "Action to perform. 'Add Full' - Ignore all existing pay packages and consider only the pay/deduction components specified in this package. 'Add Partial' - Consider all existing components and combine the new pay/deduction components specified in this pay package.",
"type": "string",
"required": true,
"enum": [
"Add Full",
"Add Partial"
]
},
"compensationDetails": {
"description": "Compensation Details",
"type": "object",
"properties": {
"cTC": {
"description": "Compensation amount for CTC",
"type": "number"
},
"basic": {
"description": "Compensation amount for Basic",
"type": "number"
},
"hRA": {
"description": "Compensation amount for HRA",
"type": "number"
},
"conveyance": {
"description": "Compensation amount for Conveyance",
"type": "number"
},
"medical": {
"description": "Compensation amount for Medical",
"type": "number"
},
"specialAllowance": {
"description": "Compensation amount for Special Allowance",
"type": "number"
},
"childrenEducationAllowance": {
"description": "Compensation amount for Children Education Allowance",
"type": "number"
},
"employerPF": {
"description": "Use the keyword 'Configure'/'Inherit' to inherit the organization's business rule for Employer PF. You can also specify a new business rule to override the organization rule for this pay package.",
"type": "string"
},
"staffLoan": {
"description": "Use the keyword 'Configure'/'Unconfigure' to configure/unconfigure Staff Loan for this pay package",
"type": "string"
},
"incentive": {
"description": "Use the keyword 'Configure'/'Unconfigure' to configure/unconfigure Incentive for this pay package",
"type": "string"
},
"leaveTravelAllowance": {
"description": "Leave Travel Allowance",
"type": "object",
"properties": {
"amount": {
"description": "Compensation amount for Leave Travel Allowance",
"type": "numeric",
"required": true
},
"businessRule": {
"description": "Use the keyword 'Configure'/'Inherit' to inherit the organization's business rule for Leave Travel Allowance. You can also specify a new business rule to override the organization rule for this pay package.",
"type": "string"
}
}
},
"carMaintenance": {
"description": "Compensation amount for Car Maintenance",
"type": "number"
},
"driverSalary": {
"description": "Compensation amount for Driver Salary",
"type": "number"
},
"reimbursement": {
"description": "Reimbursement",
"type": "object",
"properties": {
"configure": {
"description": "Use the keywords ['Configure'/'Unconfigure' or 'Yes/No'] to configure/uncofigure Reimbursement for this pay package",
"type": "string"
},
"cpg": {
"description": "Claim Procesing Group for any expense claims under this head of pay",
"type": "string",
"required": "true, if the claim is configured in the pay package",
"enum": [
"CPG",
"TPG"
]
}
}
},
"holidayPay": {
"description": "Use the keyword 'Configure'/'Inherit' to inherit the organization's business rule for Holiday Pay. You can also specify a new business rule to override the organization rule for this pay package.",
"type": "string"
},
"telephoneReimbursement": {
"description": "Telephone Reimbursement",
"type": "object",
"properties": {
"amount": {
"description": "Compensation amount for Telephone Reimbursement",
"type": "numeric",
"required": true
},
"cpg": {
"description": "Claim Procesing Group for any expense claims under this head of pay",
"type": "string",
"required": true
},
"enum": [
"CPG",
"TPG"
]
}
}
}
},
"deductionDetails": {
"description": "Deduction Details",
"type": "object",
"properties": {
"employeePF": {
"description": "Use the keyword 'Configure'/'Inherit' to inherit the organization's business rule for Employee PF. You can also specify a new business rule to override the organization rule for this pay package.",
"type": "string"
},
"otherDeduction": {
"description": "Use the keyword 'Configure'/'Inherit' to inherit the organization's business rule for Other Deduction. You can also specify a new business rule to override the organization rule for this pay package.",
"type": "string"
},
"loanDeduction": {
"description": "Loan Deduction",
"type": "object",
"properties": {
"amount": {
"description": "Deduction amount for Loan Deduction",
"type": "numeric",
"required": true
},
"fromDate": {
"description": "The date from which the fixed period deduction should start.",
"type": "string",
"format": "date",
"required": true
},
"toDate": {
"description": "The date till which the fixed period deduction should continue.",
"type": "string",
"format": "date",
"required": true
}
}
},
"parentalInsurance": {
"description": "Parental Insurance",
"type": "object",
"properties": {
"amount": {
"description": "Deduction amount for Parental Insurance",
"type": "numeric",
"required": true
},
"fromDate": {
"description": "The date from which the fixed period deduction should start.",
"type": "string",
"format": "date",
"required": true
},
"toDate": {
"description": "The date till which the fixed period deduction should continue.",
"type": "string",
"format": "date",
"required": true
}
}
},
"insuranceInLaws": {
"description": "Insurance In-Laws",
"type": "object",
"properties": {
"amount": {
"description": "Deduction amount for Insurance In-Laws",
"type": "numeric",
"required": true
},
"fromDate": {
"description": "The date from which the fixed period deduction should start.",
"type": "string",
"format": "date",
"required": true
},
"toDate": {
"description": "The date till which the fixed period deduction should continue.",
"type": "string",
"format": "date",
"required": true
}
}
}
}
}
}
}
}
}
}
2.1 Response in case of error
In case of error, the API returns the following JSON response:
|
Note:
errorMsg is a string value describing the error.
Status codes are described in the Status Codes section.
3 Coding Examples
3.1 CURL
1 |
|
- No labels