Understanding REST API Endpoints for PeopleSoft Employee Directory (employeedirectory)

This topic lists the REST resources and methods for the PeopleSoft Employee Directory API (employeedirectory). Use this API to retrieve employee details. The Employee Directory REST API can be used for the Employee Directory skill.

This table lists the delivered API resources used with the PeopleSoft Employee Directory API.

API Resource	Description
ViewEmployee	API resource to retrieve the employee details based on the Employee Name or Employee ID and Record Number.
viewdirectreports	API resource to retrieve the details of direct reportees based on manager's name or manager's ID and record number.

API resource to retrieve the employee details based on the Employee Name or Employee ID and Record Number.

Method: GET

Path: /viewemployee/{employeename}

Request Parameters	Description
employeename	Name of the employee.

Response Parameters	Response Result Type	Description
emplbuilding	Success	Employee's building.
emplbusnaddress	Success	Business address of the employee.
emplcellphone	Success	Cell phone number of the employee.
empldepartment	Success	Employee department.
emplemail	Success	Email address of the employee.
emplid	Success	Emplolee ID.
empljobtitle	Success	job title of the employee.
empllocation	Success	Location of the employee
emplnamedisplay	Success	Display name of the employee
emploperatorname	Success	Operator name of the employee.
emplphone	Success	Phone number of the employee.
emplphotourl	Success	Employee photo URL.
emplposition	Success	Position of the employee.
emplrcd	Success	Employee record.
reporteecount	Success	Count of the direct reportees.
supervisordept	Success	Supervisor's department.
supervisoremail	Success	Supervisor's email.
supervisoremplid	Success	Supervisor's Employee ID.
supervisoremplrcd	Success	Supervisor's employee record.
supervisorlocation	Success	Supervisor's location.
supervisorname	Success	Supervisor's name.
supervisorphone	Success	Supervisor's phone number.
supervisortitle	Success	Supervisor's title.

Method: GET

Path: /viewemployee/{employeeid}/{employeercd}

Request Parameters	Description
employeeid	Employee ID.
employeercd	Employee Record.

Response Parameters	Response Result Type	Description
emplbuilding	Success	Employee's building.
emplbusnaddress	Success	Business address of the employee.
emplcellphone	Success	Cell phone number of the employee.
empldepartment	Success	Employee department.
emplemail	Success	Email address of the employee.
emplid	Success	Emplolee ID.
empljobtitle	Success	job title of the employee.
empllocation	Success	Location of the employee
emplnamedisplay	Success	Display name of the employee
emploperatorname	Success	Operator name of the employee.
emplphone	Success	Phone number of the employee.
emplphotourl	Success	Employee photo URL.
emplposition	Success	Position of the employee.
emplrcd	Success	Employee record.
reporteecount	Success	Count of the direct reportees.
supervisordept	Success	Supervisor's department.
supervisoremail	Success	Supervisor's email.
supervisoremplid	Success	Supervisor's Employee ID.
supervisoremplrcd	Success	Supervisor's employee record.
supervisorlocation	Success	Supervisor's location.
supervisorname	Success	Supervisor's name.
supervisorphone	Success	Supervisor's phone number.
supervisortitle	Success	Supervisor's title.

API resource to retrieve the details of direct reportees based on manager's name or manager's ID and record number.

Method: GET

Path: /viewdirectreports/{employeename}

Request Parameters	Description
employeename	Name of the employee.

Response Parameters	Response Result Type	Description
empldepartment	Success	Employee department.
emplemail	Success	Email address of the employee.
emplid	Success	Emplolee ID.
empljobtitle	Success	job title of the employee.
empllocation	Success	Location of the employee
emplnamedisplay	Success	Display name of the employee
emplphone	Success	Phone number of the employee.
emplrcd	Success	Employee record.
reporteecount	Success	Count of the direct reportees.
supervisorname	Success	Supervisor's name.

Method: GET

Path: /viewdirectreports/{employeeid},{employeercd}

Request Parameters	Description
employeeid	Employee ID.
employeercd	Employee Record Number.

Response Parameters	Response Result Type	Description
empldepartment	Success	Employee department.
emplemail	Success	Email address of the employee.
emplid	Success	Emplolee ID.
empljobtitle	Success	job title of the employee.
empllocation	Success	Location of the employee
emplnamedisplay	Success	Display name of the employee
emplphone	Success	Phone number of the employee.
emplrcd	Success	Employee record.
reporteecount	Success	Count of the direct reportees.
supervisorname	Success	Supervisor's name.

Understanding REST API Endpoints for PeopleSoft Employee Directory (employeedirectory)

API Resources Used With the PeopleSoft Employee Directory API

ViewEmployee

Method: GET

Method: GET

viewdirectreports

Method: GET

Method: GET