### Get All Timesheet Projects Response Source: https://apidocs.peoplehr.com/ Example response containing a list of all timesheet projects. Each project includes details like ProjectId, ProjectName, and Status. ```json { "IsError": "false", "Status": 0, "Message": "string", "Result": [ { "ProjectId": 80946, "ProjectName": "Test API Project los", "Status": true, "CompanyName": "Location, REPORT TO", "LocationName": "Head Office, Mumbai, Location", "DepartmentName": "Administration, Finance, Human Service", "EmploymentType": "All", "SpecificEmployee": "Na", "JobRoleType": "Accountant, Administrator, CEO" } ] } ``` -------------------------------- ### Get Training Detail Response Source: https://apidocs.peoplehr.com/ This is a sample response schema for the Get Training Detail API, showing an array of training records. ```json { "IsError": "false", "Status": 0, "Message": "string", "Result": [ { "TrainingId": 565, "TrainingType": "Java", "Description": "Opps Concepts", "Importance": 1, "Status": 2, "PercentComplete": 0.01, "TrainingDate": "2017-10-10", "TrainingEndDate": "2015-10-11", "TrainingExpiryDate": "2015-10-12", "Provider": "John", "Cost": 0.01, "Note": "Note goes here", "CustomColumns": [ { "ColumnName": "Vehicle 1", "ColumnValue": "ABC" } ] } ] } ``` -------------------------------- ### Get All Vacancies Source: https://apidocs.peoplehr.com/ Retrieves a list of all vacancies. ```APIDOC ## POST Get all vacancies ### Description Retrieves a list of all vacancies. ### Method POST ### Endpoint /vacancy/get-all-vacancies ``` -------------------------------- ### Get Custom Screen Detail Source: https://apidocs.peoplehr.com/ Retrieves custom screen details. ```APIDOC ## POST Get Custom Screen Detail ### Description Retrieves custom screen details. ### Method POST ### Endpoint /employee-custom-screen/get-custom-screen-detail ``` -------------------------------- ### Get Training Detail Source: https://apidocs.peoplehr.com/ Retrieves training details for an employee. ```APIDOC ## POST Get Training Detail ### Description Retrieves training details for an employee. ### Method POST ### Endpoint /employee-training/get-training-detail ``` -------------------------------- ### Get All Project Task Details Source: https://apidocs.peoplehr.com/ Retrieves detailed information for all project tasks. ```APIDOC ## POST Get All Project Task Detail ### Description Retrieves detailed information for all project tasks. ### Method POST ### Endpoint /employee-project-timesheet/get-all-project-task-detail ``` -------------------------------- ### Get All Project Tasks Source: https://apidocs.peoplehr.com/ Retrieves a list of all tasks within projects. ```APIDOC ## POST Get All Project Task ### Description Retrieves a list of all tasks within projects. ### Method POST ### Endpoint /employee-project-timesheet/get-all-project-task ``` -------------------------------- ### Get All Timesheet Projects Source: https://apidocs.peoplehr.com/ Retrieves a list of all timesheet projects. ```APIDOC ## POST Get All Timesheet Project ### Description Retrieves a list of all timesheet projects. ### Method POST ### Endpoint /employee-project-timesheet/get-all-timesheet-project ``` -------------------------------- ### Get Work Pattern Detail Source: https://apidocs.peoplehr.com/ Retrieves work pattern details. ```APIDOC ## POST Get work pattern detail ### Description Retrieves work pattern details. ### Method POST ### Endpoint /workpattern/get-work-pattern-detail ``` -------------------------------- ### Request Sample for GetAllProjectTask Source: https://apidocs.peoplehr.com/ Use this sample to retrieve all project tasks. Ensure the APIKey is valid and the Action is set to 'GetAllProjectTask'. ```json { "APIKey": "5127e153-2c80-492b-a9e4-fb3e50af61a8", "Action": "GetAllProjectTask", "ProjectTaskName": "ABC" } ``` -------------------------------- ### Get Employee Appraisal By Employee ID Request Source: https://apidocs.peoplehr.com/ This snippet shows the request body for retrieving employee appraisal details by Employee ID. Optional start and end dates can be provided. ```json { "APIKey": "5127e153-2c80-492b-a9e4-fb3e50af61a8", "Action": "GetByEmployeeId", "EmployeeId": "PW180", "StartDate": "2016-07-27", "EndDate": "2017-07-27" } ``` -------------------------------- ### Employee Appraisal Response Example Source: https://apidocs.peoplehr.com/ This is a sample successful response when retrieving employee appraisal data. It includes details about the appraisal, reviewer, and associated files. ```json { "IsError": "false", "Status": 0, "Message": "string", "Result": { "AppraisalId": 383, "AppraisalReviewDate": "2017-05-01", "Reviewer": "Krushna Bapat", "Note": "Notes goes here", "ActionPlan": "11", "Objectives": "121", "Customfields": [ { "ColumnName": "MNO", "ColumnValue": "file" } ], "Files": [ { "DocumentName": "filelode.pdf", "Description": "dsddsds", "FileUrl": "http://reportsto.localhost.net:12345/Handlers/MyDocsViewer.ashx?bf26a772-3891-449e-b8f6-a06248b455b3", "Category": "catagory", "SignatureRequired": "false" } ] } } ``` -------------------------------- ### Get Custom Screen Detail Response Source: https://apidocs.peoplehr.com/ A successful response (200 OK) for getting custom screen details. It indicates no error and returns a list of custom screen results, each with a ScreenId and ScreenName. ```json { "IsError": "false", "Status": 0, "Message": "string", "Result": [ { "ScreenId": 1014, "ScreenName": "Grievance" } ] } ``` -------------------------------- ### Request Sample for GetAllProjectTaskDetail Source: https://apidocs.peoplehr.com/ Use this sample to retrieve all details for a specific project task by providing its name. ```json { "APIKey": "5127e153-2c80-492b-a9e4-fb3e50af61a8", "Action": "GetAllProjectTaskDetail", "ProjectTaskDetailName": "XYZ" } ``` -------------------------------- ### Get Custom Screen By Employee Id Response Source: https://apidocs.peoplehr.com/ A successful response (200 OK) for getting custom screen details by employee ID. The result includes transaction ID, custom fields, and associated files. ```json { "IsError": "false", "Status": 0, "Message": "string", "Result": [ { "TxnId": 521, "Customfields": [ { "ColumnName": "Text Field", "ColumnValue": "126" } ], "Files": [ { "DocumentName": "2.pdf", "Description": "File description", "FileUrl": "http://techinfo.localhost.net:12345/Handlers/MyDocsViewer.ashx?3489f8dc-629f-4830-b1de-fdc0f943596e", "Category": "Custom Category", "SignatureRequired": false } ] } ] } ``` -------------------------------- ### Response for Get All Vacancies Source: https://apidocs.peoplehr.com/ A sample successful response (200 OK) for the GetAllVacancies API call, returning a list of vacancy objects. ```json { "IsError": "false", "Status": 0, "Message": "string", "Result": [ { "VacancyName": "IT Programmer", "VacancyDescription": "IT Programmer", "Company": "Company name", "Location": "Mumbai", "Department": "IT", "Status": 2, "ClosingDate": "2016-07-31", "Reference": "VA4", "SalaryRange": "10000", "JobDescription": "Job Description", "IsHideSalary": false, "JobTitle": "Software Engineer", "VacancyType": "Internal", "City": "Mumbai", "Country": "India", "Experience": "4 Year", "JobBordUrl": "http://itgpeoplehr.localhost.net:12345/Pages/JobBoard/Opening.aspx?v=b3df0ea6-69ec-458e-a045-a85c92de6514", "AdditionalQuestions": [ { "QuestionId": "2", "QuestionType": "1", "IsMandatory": "true", "Question": "Please indicate your gender", "AdditionalOrInternalType": "1", "QuestionOptions": [ { "QuestionOptions": "string" } ] } ], "InternalQuestions": [ { "QuestionId": "2", "QuestionType": "1", "IsMandatory": "true", "Question": "Please indicate your gender", "AdditionalOrInternalType": "1", "QuestionOptions": [ { "QuestionOptions": "string" } ] } ] } ] } ``` -------------------------------- ### Add New Project Request Source: https://apidocs.peoplehr.com/ Use this to add a new project. Provide the ProjectName and specify if it's 'InUse' with 'Yes' or 'No'. ```json { "APIKey": "5127e153-2c80-492b-a9e4-fb3e50af61a8", "Action": "AddNewProject", "ProjectName": "Project Name", "InUse": "Yes" } ``` -------------------------------- ### Get Project Timesheet Detail Response Source: https://apidocs.peoplehr.com/ Sample response for retrieving project timesheet details. The 'Result' array contains detailed entries if successful. ```json { "IsError": "false", "Status": 0, "Message": "string", "Result": [ { "TransactionId": "561", "ProjectTimesheetDate": "2014-11-03", "TimesheetProject": "Project", "TimesheetTask": "Task", "TimesheetDetail": "Detail", "StartTime": "05:00", "EndTime": "09:00", "TotalHours": "04:00", "Quantity": "0.00", "Notes": "Notes show here..", "ChangedDate": "2014-11-03" } ] } ``` -------------------------------- ### Get Vacancy Source: https://apidocs.peoplehr.com/ Retrieves vacancy information. ```APIDOC ## POST Get vacancy ### Description Retrieves vacancy information. ### Method POST ### Endpoint /vacancy/get-vacancy ``` -------------------------------- ### Get Other Event Detail Source: https://apidocs.peoplehr.com/ Retrieves details for other events. ```APIDOC ## POST Get Other Event Detail ### Description Retrieves details for other events. ### Method POST ### Endpoint /other-event/get-other-event-detail ``` -------------------------------- ### Upload Employee Document Request Sample Source: https://apidocs.peoplehr.com/ Use this sample to upload a document for an employee. Ensure the file is base64 encoded and all access parameters are set correctly. ```json { "APIKey": "5127e153-2c80-492b-a9e4-fb3e50af61a8", "Action": "UploadEmployeeDocument", "EmployeeId": "PW180", "Category": "string", "EmployeeAccess": true, "ManagerAccess": true, "SignatureRequired": true, "DocumentName": "string", "Description": "string", "File": "string" } ``` -------------------------------- ### Request Sample for EditProjectTask Source: https://apidocs.peoplehr.com/ This sample demonstrates how to edit an existing project task. Provide the current task name and the new name, along with the 'InUse' status. ```json { "APIKey": "5127e153-2c80-492b-a9e4-fb3e50af61a8", "Action": "EditProjectTask", "ProjectTaskName": "ABC", "New_ProjectTaskName": "XYZ", "InUse": "Yes" } ``` -------------------------------- ### Get All Employee Details Source: https://apidocs.peoplehr.com/ Retrieves details for all employees. ```APIDOC ## POST Get All Employee Detail ### Description Retrieves details for all employees. ### Method POST ### Endpoint /employee/get-all-employee-detail ``` -------------------------------- ### Add Training Detail Request Source: https://apidocs.peoplehr.com/ Example payload for adding a new training detail record. Ensure all required fields are populated correctly. ```json { "APIKey": "5127e153-2c80-492b-a9e4-fb3e50af61a8", "Action": "addtrainingdetail", "EmployeeId": "PW180", "TrainingType": "Java", "Description": "Description here", "Importance": "1", "Status": "2", "InProgress": "10", "TrainingDate": "2017-10-10", "TrainindEndDate": "2015-10-11", "TrainingExpiryDate": "2015-10-12", "Cost": "0.01", "Provider": "John", "Notes": "notes goes here", "CustomColumns": [ { "ColumnName": "Vehicle 1", "ColumnValue": "ABC" } ], "AddFiles": [ { "DocumentName": "my.txt", "File": "Base 64 code", "Descriptions": "Descriptions goes here", "DocumentCategory": "Custom Catagory", "SignatureRequired": "False" } ] } ``` -------------------------------- ### Get Other Event Entitlement Source: https://apidocs.peoplehr.com/ Retrieves entitlement details for other events. ```APIDOC ## POST Get Other Event Entitlement ### Description Retrieves entitlement details for other events. ### Method POST ### Endpoint /other-event/get-other-event-entitlement ``` -------------------------------- ### Request Sample for AddNewProjectTask Source: https://apidocs.peoplehr.com/ Use this sample to add a new project task. The 'InUse' field must be either 'Yes' or 'No'. ```json { "APIKey": "5127e153-2c80-492b-a9e4-fb3e50af61a8", "Action": "AddNewProjectTask", "ProjectTaskName": "ABC", "InUse": "Yes" } ``` -------------------------------- ### Response Sample for GetAllProjectTask Source: https://apidocs.peoplehr.com/ This is a successful response structure for retrieving project tasks. It includes task details such as ID, name, status, and associated project name. ```json { "IsError": "false", "Status": 0, "Message": "string", "Result": [ { "ProjectTaskId": 80980, "ProjectTaskName": "ProjectTaskName name", "Status": true, "ProjectName": "ProjectName goes here" } ] } ``` -------------------------------- ### Create New Applicant Request Sample Source: https://apidocs.peoplehr.com/ This JSON object demonstrates the required fields for creating a new applicant via the API. Ensure all required fields are populated correctly. ```json { "APIKey": "5127e153-2c80-492b-a9e4-fb3e50af61a8", "Action": "CreateNewApplicant", "VacancyReference": "VA4", "FirstName": "Ranjit", "LastName": "Johnson", "Email": "vaibhavid@itgurussoftware.com", "Gender": "female", "DateOfBirth": "1999-01-02", "PostCode": "413608", "Address": "Shiv Colony, Thergaon - Pune", "PhoneNumber": "8899556885", "OtherContactDetails": "8899556885", "Source": "Facebook", "AdditionalQuestions": [ { "QuestionId": "2", "Value": "1" } ], "InternalQuestions": [ { "QuestionId": "2", "Value": "1" } ], "Documents": [ { "DocumentName": "xyz.png", "Url": "www.google.com/doc2.docx" } ], "Skills": "C#, Asp.net, JQuery", "RecruitmentCost": "50", "DateLastContacted": "2016-01-13" } ``` -------------------------------- ### Get All Employee Documents Source: https://apidocs.peoplehr.com/ Retrieves all documents associated with an employee. ```APIDOC ## POST Get All Document ### Description Retrieves all documents associated with an employee. ### Method POST ### Endpoint /employee-document/get-all-document ``` -------------------------------- ### Get Absence Detail Source: https://apidocs.peoplehr.com/ Retrieves absence details for an employee. ```APIDOC ## POST Get Absence Detail ### Description Retrieves absence details for an employee. ### Method POST ### Endpoint /employee-absence/get-absence-detail ``` -------------------------------- ### Get Holiday Detail Source: https://apidocs.peoplehr.com/ Retrieves holiday details for an employee. ```APIDOC ## POST Get Holiday Detail ### Description Retrieves holiday details for an employee. ### Method POST ### Endpoint /employee-holiday/get-holiday-detail ``` -------------------------------- ### Upload Applicant Document Request Sample Source: https://apidocs.peoplehr.com/ This JSON object illustrates the parameters required to upload a document for an applicant. Ensure the File is provided as a base64 string. ```json { "APIKey": "5127e153-2c80-492b-a9e4-fb3e50af61a8", "Action": "uploadapplicantdocument", "ApplicantId": "90", "DocumentName": "Abc.txt", "Description": "Description here", "File": "Pass base64 string" } ``` -------------------------------- ### Get Salary Detail Source: https://apidocs.peoplehr.com/ Retrieves salary details for an employee. ```APIDOC ## POST Get Salary Detail ### Description Retrieves salary details for an employee. ### Method POST ### Endpoint /employee-salary/get-salary-detail ``` -------------------------------- ### Response Sample for GetAllProjectTaskDetail Source: https://apidocs.peoplehr.com/ This is a successful response structure for retrieving project task details. It includes details like ID, name, status, and the associated project task name. ```json { "IsError": "false", "Status": 0, "Message": "string", "Result": [ { "ProjectTaskDetailId": 80961, "ProjectTaskDetailName": "Task details goes here", "Status": false, "ProjectTaskName": "All" } ] } ``` -------------------------------- ### Get Training Detail Source: https://apidocs.peoplehr.com/ Retrieves the training details for a specific employee. ```APIDOC ## GET /Employee Training - GetTrainingDetail ### Description Retrieves the training details for a specific employee. ### Method POST ### Endpoint https://api.peoplehr.net/Training ### Request Body - **APIKey** (string) - Required - APIKey for get training detail (<= 50 characters). - **Action** (string) - Required - Action name, should be "GetTrainingDetail". - **EmployeeId** (string) - Required - Employee ID for get training detail (<= 15 characters). ### Request Example ```json { "APIKey": "5127e153-2c80-492b-a9e4-fb3e50af61a8", "Action": "GetTrainingDetail", "EmployeeId": "PW180" } ``` ### Response #### Success Response (200) - **IsError** (string) - Indicates if an error occurred ('true' or 'false'). - **Status** (integer) - Status code of the response. - **Message** (string) - A message describing the result of the operation. - **Result** (array) - An array of training detail objects. - **TrainingId** (integer) - The ID of the training. - **TrainingType** (string) - The type of training. - **Description** (string) - Description of the training. - **Importance** (integer) - Importance level of the training. - **Status** (integer) - Status of the training. - **PercentComplete** (number) - Percentage of completion. - **TrainingDate** (string) - Date the training was undertaken (YYYY-MM-DD). - **TrainingEndDate** (string) - End date of the training (YYYY-MM-DD). - **TrainingExpiryDate** (string) - Expiry date of the training (YYYY-MM-DD). - **Provider** (string) - The training provider. - **Cost** (number) - Cost of the training. - **Note** (string) - Notes related to the training. - **CustomColumns** (array) - An array of custom columns for the training. - **ColumnName** (string) - Name of the custom column. - **ColumnValue** (string) - Value of the custom column. #### Response Example ```json { "IsError": "false", "Status": 0, "Message": "string", "Result": [ { "TrainingId": 565, "TrainingType": "Java", "Description": "Opps Concepts", "Importance": 1, "Status": 2, "PercentComplete": 0.01, "TrainingDate": "2017-10-10", "TrainingEndDate": "2015-10-11", "TrainingExpiryDate": "2015-10-12", "Provider": "John", "Cost": 0.01, "Note": "Note goes here", "CustomColumns": [ { "ColumnName": "Vehicle 1", "ColumnValue": "ABC" } ] } ] } ``` ``` -------------------------------- ### Get Maternity Paternity By ID Source: https://apidocs.peoplehr.com/ Retrieves maternity/paternity information by its ID. ```APIDOC ## POST Get by maternity paternity id ### Description Retrieves maternity/paternity information by its ID. ### Method POST ### Endpoint /maternity-paternity/get-by-maternity-paternity-id ``` -------------------------------- ### GetAllVacancies Source: https://apidocs.peoplehr.com/ Retrieves a list of all available vacancies. Requires an API key and the action 'GetAllVacancies'. ```APIDOC ## POST /Vacancy - GetAllVacancies ### Description Retrieves a list of all available vacancies. Requires an API key and the action 'GetAllVacancies'. ### Method POST ### Endpoint https://api.peoplehr.net/Vacancy ### Parameters #### Request Body - **APIKey** (string) - Required - APIKey for vacancy api to get all vacancy. - **Action** (string) - Required - Action name must be 'GetAllVacancies'. ### Request Example ```json { "APIKey": "5127e153-2c80-492b-a9e4-fb3e50af61a8", "Action": "GetAllVacancies" } ``` ### Response #### Success Response (200) - **IsError** (string) - Indicates if an error occurred. - **Status** (integer) - The status code of the response. - **Message** (string) - A message describing the response. - **Result** (array) - Contains a list of vacancy details. - **VacancyName** (string) - **VacancyDescription** (string) - **Company** (string) - **Location** (string) - **Department** (string) - **Status** (integer) - **ClosingDate** (string) - **Reference** (string) - **SalaryRange** (string) - **JobDescription** (string) - **IsHideSalary** (boolean) - **JobTitle** (string) - **VacancyType** (string) - **City** (string) - **Country** (string) - **Experience** (string) - **JobBordUrl** (string) - **AdditionalQuestions** (array) - **InternalQuestions** (array) #### Response Example ```json { "IsError": "false", "Status": 0, "Message": "string", "Result": [ { "VacancyName": "IT Programmer", "VacancyDescription": "IT Programmer", "Company": "Company name", "Location": "Mumbai", "Department": "IT", "Status": 2, "ClosingDate": "2016-07-31", "Reference": "VA4", "SalaryRange": "10000", "JobDescription": "Job Description", "IsHideSalary": false, "JobTitle": "Software Engineer", "VacancyType": "Internal", "City": "Mumbai", "Country": "India", "Experience": "4 Year", "JobBordUrl": "http://itgpeoplehr.localhost.net:12345/Pages/JobBoard/Opening.aspx?v=b3df0ea6-69ec-458e-a045-a85c92de6514", "AdditionalQuestions": [ { "QuestionId": "2", "QuestionType": "1", "IsMandatory": "true", "Question": "Please indicate your gender", "AdditionalOrInternalType": "1", "QuestionOptions": [ { "QuestionOptions": "string" } ] } ], "InternalQuestions": [ { "QuestionId": "2", "QuestionType": "1", "IsMandatory": "true", "Question": "Please indicate your gender", "AdditionalOrInternalType": "1", "QuestionOptions": [ { "QuestionOptions": "string" } ] } ] } ] } ``` ``` -------------------------------- ### Create Project Timesheet Source: https://apidocs.peoplehr.com/ Creates a new project timesheet entry. ```APIDOC ## POST Create project timesheet ### Description Creates a new project timesheet entry. ### Method POST ### Endpoint /employee-project-timesheet/create-project-timesheet ``` -------------------------------- ### Get Right to Work Detail Response Source: https://apidocs.peoplehr.com/ This is a sample successful response for retrieving right to work details. It includes document information and validity periods. ```json { "IsError": "false", "Status": 0, "Message": "string", "Result": [ { "RightToWorkId": "156", "DocumentType": "Residence Permit", "DocumentId": "10", "ValidFrom": "Thu, 01 Jan 2015", "ValidTo": "Fri, 02 jan 2015", "Duration": "2", "DocumentName": "api.txt", "DocumentURL": "http://techinfo.localhost.net:12345/Handlers/MyDocsViewer.ashx?4a9b1332-3f71-4e96-859c-d1eaeaab3ea4", "Comments": "NICE" } ] } ``` -------------------------------- ### Get Holiday Entitlement Source: https://apidocs.peoplehr.com/ Retrieves current holiday entitlement information. ```APIDOC ## POST Get Holiday Entitlement ### Description Retrieves current holiday entitlement information. ### Method POST ### Endpoint /holiday-entitlement/get-holiday-entitlement ``` -------------------------------- ### AddNewProject Source: https://apidocs.peoplehr.com/ Adds a new project with specified details, including its name and usage status. ```APIDOC ## POST /Employee Project Timesheet - AddNewProject ### Description Adds a new project with specified details, including its name and usage status. ### Method POST ### Endpoint https://api.peoplehr.net/ProjectTimesheet ### Parameters #### Request Body - **APIKey** (string) - Required - APIKey for employee api to add new project. Max length 50 characters. - **Action** (string) - Required - Action name = AddNewProject. - **ProjectName** (string) - Required - ProjectName for add new project. Max length 100 characters. - **InUse** (string) - Required - "Yes" or "No" indicating if the project is in use. ### Request Example { "APIKey": "5127e153-2c80-492b-a9e4-fb3e50af61a8", "Action": "AddNewProject", "ProjectName": "Project Name", "InUse": "Yes" } ### Response #### Success Response (200) - **IsError** (string) - Indicates if an error occurred. - **Status** (integer) - The status code of the response. - **Message** (string) - A message describing the result of the operation. - **Result** (object) - An empty object, typically indicating success. #### Response Example { "IsError": "false", "Status": 0, "Message": "string", "Result": { } } ``` -------------------------------- ### Create New Applicant Response Sample Source: https://apidocs.peoplehr.com/ This JSON object shows a successful response when creating a new applicant. It indicates whether an error occurred and provides applicant details. ```json { "IsError": "false", "Status": 0, "Message": "string", "Result": { "IsDuplicate": "true", "ApplicantId": 4 } } ``` -------------------------------- ### Get Late By Employee ID Source: https://apidocs.peoplehr.com/ Retrieves late records for an employee by their ID. ```APIDOC ## POST Get late by employeeId ### Description Retrieves late records for an employee by their ID. ### Method POST ### Endpoint /employeee-late/get-late-by-employeeid ``` -------------------------------- ### Get All Vacancies Request Source: https://apidocs.peoplehr.com/ This snippet shows the request payload for fetching all available vacancies. It requires the APIKey and the specific Action 'GetAllVacancies'. ```json { "APIKey": "5127e153-2c80-492b-a9e4-fb3e50af61a8", "Action": "GetAllVacancies" } ``` -------------------------------- ### Response for Get Vacancy Source: https://apidocs.peoplehr.com/ This is a sample successful response (200 OK) for the GetVacancy API call, detailing the structure of vacancy information. ```json { "IsError": "false", "Status": 0, "Message": "string", "Result": { "VacancyName": "IT Programmer", "VacancyDescription": "IT Programmer", "Company": "Company name", "Location": "Mumbai", "Department": "IT", "Status": 2, "ClosingDate": "2016-07-31", "Reference": "VA4", "SalaryRange": "10000", "JobDescription": "Job Description", "IsHideSalary": false, "JobTitle": "Software Engineer", "VacancyType": "Internal", "City": "Mumbai", "Country": "India", "Experience": "4 Year", "JobBordUrl": "http://itgpeoplehr.localhost.net:12345/Pages/JobBoard/Opening.aspx?v=b3df0ea6-69ec-458e-a045-a85c92de6514", "AdditionalQuestions": [ { "QuestionId": "2", "QuestionType": "1", "IsMandatory": "true", "Question": "Please indicate your gender", "AdditionalOrInternalType": "1", "QuestionOptions": [ { "QuestionOptions": "string" } ] } ], "InternalQuestions": [ { "QuestionId": "2", "QuestionType": "1", "IsMandatory": "true", "Question": "Please indicate your gender", "AdditionalOrInternalType": "1", "QuestionOptions": [ { "QuestionOptions": "string" } ] } ] } } ``` -------------------------------- ### Get Right To Work Detail Source: https://apidocs.peoplehr.com/ Retrieves right to work details for an employee. ```APIDOC ## POST Get Right To Work Detail ### Description Retrieves right to work details for an employee. ### Method POST ### Endpoint /right-to-work/get-right-to-work-detail ``` -------------------------------- ### Response for All Employee Details Source: https://apidocs.peoplehr.com/ This is a sample successful response (200 OK) for the GetAllEmployeeDetail request. It contains a list of employee objects, each with detailed fields and their history. ```json { "IsError": "false", "Status": 0, "Message": "string", "Result": [ { "EmployeeId": { "DisplayValue": "PW180", "FieldHistory": [ { "OldValue": "Old value", "NewValue": "New value", "ChangedOn": "2017-07-12", "ReasonForChange": "Reason for change" } ] }, "Title": { "DisplayValue": "Mr.", "FieldHistory": [ { "OldValue": "Old value", "NewValue": "New value", "ChangedOn": "2017-07-12", "ReasonForChange": "Reason for change" } ] }, "FirstName": { "DisplayValue": "Employee first name", "FieldHistory": [ { "OldValue": "Old value", "NewValue": "New value", "ChangedOn": "2017-07-12", "ReasonForChange": "Reason for change" } ] }, "LastName": { "DisplayValue": "Employee last name", "FieldHistory": [ { "OldValue": "Old value", "NewValue": "New value", "ChangedOn": "2017-07-12", "ReasonForChange": "Reason for change" } ] }, "OtherName": { "DisplayValue": "Other name", "FieldHistory": [ { "OldValue": "Old value", "NewValue": "New value", "ChangedOn": "2017-07-12", "ReasonForChange": "Reason for change" } ] }, "KnownAs": { "DisplayValue": "Known as value", "FieldHistory": [ { "OldValue": "Old value", "NewValue": "New value", "ChangedOn": "2017-07-12", "ReasonForChange": "Reason for change" } ] }, "EmailId": { "DisplayValue": "firstname.lastname@itgurusssoftware.com", "FieldHistory": [ { "OldValue": "Old value", "NewValue": "New value", "ChangedOn": "2017-07-12", "ReasonForChange": "Reason for change" } ] }, "StartDate": { "DisplayValue": "2014-01-01", "FieldHistory": [ { "OldValue": "Old value", "NewValue": "New value", "ChangedOn": "2017-07-12", "ReasonForChange": "Reason for change" } ] }, "DateOfBirth": { "DisplayValue": "1991-08-07", "FieldHistory": [ { "OldValue": "Old value", "NewValue": "New value", "ChangedOn": "2017-07-12", "ReasonForChange": "Reason for change" } ] }, "JobRole": { "DisplayValue": "Software Enginner", "FieldHistoryForJobRole": [ { "JobRole": "Software enginner", "EffectiveDate": "2015-06-20", "ChangedOn": "2017-07-12", "ReasonForChange": "Reason for change" } ] }, "Company": { "DisplayValue": "Company name", "FieldHistoryForEffectiveDate": [ { "FieldData": "don't know", "EffectiveDate": "2014-07-12", "ChangedOn": "2017-07-12", "ReasonForChange": "Reason for change" } ] }, "CompanyEffectiveDate": { "DisplayValue": "2014-01-01" }, "Location": { "DisplayValue": "Mumbai", "FieldHistoryForEffectiveDate": [ { "FieldData": "don't know", "EffectiveDate": "2014-07-12", "ChangedOn": "2017-07-12", "ReasonForChange": "Reason for change" } ] }, "LocationEffectiveDate": { "DisplayValue": "2017-02-02" }, "Department": { "DisplayValue": "IT", "FieldHistoryForEffectiveDate": [ { "FieldData": "don't know", "EffectiveDate": "2014-07-12", "ChangedOn": "2017-07-12", "ReasonForChange": "Reason for change" } ] }, "DepartmentEffectiveDate": { "DisplayValue": "2017-05-01" }, "JobRoleChangeDate": { "DisplayValue": "2017-05-05" }, "ReportsTo": { "DisplayValue": "FirstName LastName", "FieldHistoryForEffectiveDate": [ { "FieldData": "don't know", "EffectiveDate": "2014-07-12", "ChangedOn": "2017-07-12", "ReasonForChange": "Reason for change" } ] }, "ReportsToEffectiveDate": { "DisplayValue": "" } } ] } ``` -------------------------------- ### Get Vehicle By Employee ID Source: https://apidocs.peoplehr.com/ Retrieves vehicle information for an employee by their ID. ```APIDOC ## POST Get Vehicle By Employee Id ### Description Retrieves vehicle information for an employee by their ID. ### Method POST ### Endpoint /employee-vehicle/get-vehicle-by-employee-id ``` -------------------------------- ### Add New Project Task Detail Source: https://apidocs.peoplehr.com/ Adds a new project task detail to the system. Requires APIKey, Action, ProjectTaskDetailName, and InUse status. ```APIDOC ## POST /Employee Project Timesheet - AddNewProjectTaskDetail ### Description This API is used to add a new project task detail. ### Method POST ### Endpoint https://api.peoplehr.net/ProjectTimesheet ### Parameters #### Request Body - **APIKey** (string) - Required - APIKey for employee api to add new project task detail (<= 50 characters). - **Action** (string) - Required - Action name = AddNewProjectTaskDetail. - **ProjectTaskDetailName** (string) - Required - Project task detail name for add new project task detail (<= 100 characters). - **InUse** (string) - Required - In use for add new project task detail ('Yes' or 'No'). ### Request Example ```json { "APIKey": "5127e153-2c80-492b-a9e4-fb3e50af61a8", "Action": "AddNewProjectTaskDetail", "ProjectTaskDetailName": "XYZ", "InUse": "Yes" } ``` ### Response #### Success Response (200) - **IsError** (string) - Indicates if an error occurred. - **Status** (integer) - The status code of the response. - **Message** (string) - A message describing the result of the operation. - **Result** (object) - An empty object, indicating success. #### Response Example ```json { "IsError": "false", "Status": 0, "Message": "string", "Result": {} } ``` ``` -------------------------------- ### Get Vehicle Detail By ID Source: https://apidocs.peoplehr.com/ Retrieves a specific vehicle detail by its ID. ```APIDOC ## POST Get By Vehicle Detail Id ### Description Retrieves a specific vehicle detail by its ID. ### Method POST ### Endpoint /employee-vehicle/get-by-vehicle-detail-id ``` -------------------------------- ### Add New Project Source: https://apidocs.peoplehr.com/ Adds a new project to the timesheet system. ```APIDOC ## POST Add New Project ### Description Adds a new project to the timesheet system. ### Method POST ### Endpoint /employee-project-timesheet/add-new-project ```