Understanding REST API Endpoints for PeopleSoft Applicant Activity (hrsapplicantcgactivity)
This topic lists the REST resources and methods for the Applicant Activity API (hrsapplicantcgactivity). Use this API to retrieve applicant activity with the Recruiting Solutions Careers page. The Applicant Activity API can be used for the Recruiting Skill.
This table lists the delivered API resources used with the Applicant Activity API.
|
API Resource |
Description |
|---|---|
|
API resource to retrieve job application details for an applicant. |
|
|
API resource to generate applicant name. |
|
|
API resource to retrieve applicant notification details. |
|
|
API resource to retrieve an applicant's saved searches (job agents) in the Recruiting Solutions Careers page. |
API resource to retrieve job application details for an applicant.
Method: GET
Path:/applications/{siteid}/{sessionid}/{begindate}/{enddate}/{status}
|
Request Parameters |
Description |
|---|---|
|
begindate |
Application begin date. |
|
enddate |
Application end date. |
|
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. |
|
status |
Application status. |
|
Response Parameters |
Response Result Type |
Description |
|---|---|---|
|
alternatesearchdone |
Success |
Alternate search done. This flag indicates whether an alternate search was performed by the API when the API was unable to fetch the necessary application based on input parameters. |
|
appjobopeningid |
Success |
Application job opening ID. |
|
applicationstatuscode |
Success |
Application status code. |
|
applicationstatushelptext |
Success |
Application status help text. Provides application status details. |
|
apppostingtitle |
Success |
Application posting title (job post title). |
|
date |
Success |
Application date. |
|
lastchangedate |
Success |
Date the application was last modified. |
|
profilesequence |
Success |
Profile sequence of the application. |
|
status |
Success |
Application status. |
|
submitsource |
Success |
Submit source (indicates whether an applicant applied to the job or a recruiter attached applicant to the job). |
API resource to generate applicant name.
Method: GET
Path:/applicantdetails/name/{siteid}/{sessionid}
|
Request Parameters |
Description |
|---|---|
|
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 |
|---|---|---|
|
name |
Success |
Applicant name. |
API resource to retrieve applicant notification details.
Method: GET
Path:/notifications/{siteid}/{sessionid}/{begindate}/{enddate}/{status}/{type}
|
Request Parameters |
Description |
|---|---|
|
begindate |
Application begin date. |
|
enddate |
Application end date. |
|
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. |
|
status |
Application status. |
|
type |
Application type. |
|
Response Parameters |
Response Result Type |
Description |
|---|---|---|
|
date |
Success |
Notification date. |
|
notificationstatusdesc |
Success |
Notification status description. |
|
notificationsubject |
Success |
Notification subject. |
|
notificationtype |
Success |
Notification type. |
|
notificationtypedescr |
Success |
Notification type description. |
|
status |
Success |
Notification status. |
|
timereceived |
Success |
Time the notification was received. |
API resource to retrieve an applicant's saved searches (job agents) in the Recruiting Solutions Careers page.
Method: GET
Path:/savedsearchesforjobs/{siteid}/{sessionid}
|
Request Parameters |
Description |
|---|---|
|
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 |
|---|---|---|
|
facets |
Success |
Search facets. |
|
keyword |
Success |
Keyword search. |
|
name |
Success |
Search name. |
|
postedwithin |
Success |
Posted within (number of days since the job was posted). |