Understanding REST API Endpoints for PeopleSoft Job Search Services (hrsjobs)
This topic lists the REST resources and methods for the PeopleSoft Job Search Services API (hrsjobs). Use this API to facilitate job searches. The Job Search Services API can be used for the Recruiting Skill.
This table lists the delivered API resource used with the PeopleSoft Job Search Services API.
|
API Resource |
Description |
|---|---|
|
API resource to facilitate job searches using the Candidate Gateway. |
API resource to facilitate job searches using the Candidate Gateway.
Method: GET
Path: /searchjobs/{siteid}/{searchstring}
|
Request Parameters |
Description |
|---|---|
|
searchstring |
Search keyword. |
|
siteid |
Site ID. This is a unique ID created with the Site Setup page in PeopleSoft Candidate Gateway. |
|
Response Parameters |
Response Result Type |
Description |
|---|---|---|
|
encodedparameter |
Success |
Encoded parameter. This refers to the specific parameter used to form the URL in chat so user can access the Careers page with the appropriate search results pre-listed. |
|
jobopeningid |
Success |
Job opening ID. |
|
jobpostingsequence |
Success |
Job posting sequence number. A job opening can have different job postings, each identified with a different sequence number. |
|
postdate |
Success |
Job posting date. |
|
postingcount |
Success |
Job posting count. |
|
postingtitle |
Success |
Job posting title. |
Method: GET
Path: /searchjobs/keyword/{siteid}/{sessionid}/{searchstring}
|
Request Parameters |
Description |
|---|---|
|
searchstring |
Search keyword. |
|
sessionid |
Session ID. This is a unique ID generated when an applicant accesses a Recruiting Solutions Careers site and signs in with their user ID and password. This ID is passed to Recruiting Solutions Digital Assistant. |
|
siteid |
Site ID. This is a unique ID created with the Site Setup page in PeopleSoft Candidate Gateway. |
|
Response Parameters |
Response Result Type |
Description |
|---|---|---|
|
encodedparameter |
Success |
Encoded parameter. This refers to the specific parameter used to form the URL in chat so user can access the Careers page with the appropriate search results pre-listed. |
|
jobopeningid |
Success |
Job opening ID. |
|
jobpostingsequence |
Success |
Job posting sequence number. A job opening can have different job postings, each identified with a different sequence number. |
|
postdate |
Success |
Job posting date. |
|
postingcount |
Success |
Job posting count. |
|
postingtitle |
Success |
Job posting title. |
Method: GET
Path: /searchjobs/savedsearchname/{siteid}/{sessionid}/{savedsearchname}
|
Request Parameters |
Description |
|---|---|
|
savedsearchname |
Name of saved search. |
|
sessionid |
Session ID. This is a unique ID generated when an applicant accesses a Recruiting Solutions Careers site and signs in with their user ID and password. This ID is passed to Recruiting Solutions Digital Assistant. |
|
siteid |
Site ID. This is a unique ID created with the Site Setup page in PeopleSoft Candidate Gateway. |
|
Response Parameters |
Response Result Type |
Description |
|---|---|---|
|
encodedparameter |
Success |
Encoded parameter. This refers to the specific parameter used to form the URL in chat so user can access the Careers page with the appropriate search results pre-listed. |
|
jobopeningid |
Success |
Job opening ID. |
|
jobpostingsequence |
Success |
Job posting sequence number. A job opening can have different job postings, each identified with a different sequence number. |
|
postdate |
Success |
Job posting date. |
|
postingcount |
Success |
Job posting count. |
|
postingtitle |
Success |
Job posting title. |