Understanding REST API Endpoints for PeopleSoft Absence Management Application Services (absence)

This topic lists the REST resources and methods for the PeopleSoft Absence Management Application Services API (absence). Use this API to create and manage absence requests, and view absence balances. The Absence Management Application Services REST API can be used for the Absence skill.

This table lists the delivered API resources used with the PeopleSoft Absence API.

API Resource	Description
request	API resource to create, update, and retrieve absence request information.
balance	API resource to retrieve employee absence balance information.
configuration	API resource to retrieve absence configuration information, which was set up in Absence Management. Configuration information includes rules and input fields applicable for a particular absence type.
validation	API resource to validate absence information that was input by a user when they created an absence request.
employee	API resource to retrieve employee information.

API resource to create, update, and retrieve absence request information.

Method: POST

Path: /request/createabsence

Request Parameters	Description
absencereason	Reason for absence.
charuf1	Character type user field number one.
charuf2	Character type user field number two.
charuf3	Character type user field number three.
charuf4	Character type user field number four.
comments	Absence request comments.
durationabs	Absence duration.
durationdays	Absence duration, days.
durationhrs	Absence duration, hours.
emplid	Employee ID.
emplrcd	Employee record.
enddt	Absence end date.
numuf1	Number type user field, number one.
numuf2	Number type user field, number two.
numuf3	Number type user field, number three.
numuf4	Number type user field, number four.
pintakenum	Pin take number.
seqnumuf1	Sequence number field one.
seqnumuf2	Sequence number field two.
seqnumuf3	Sequence number field three.
seqnumuf4	Sequence number field four.
startdt	Absence begin date.

Response Parameters	Response Result Type	Description
msgout	Success	Message out. This is the message returned after the API is executed.

Response Parameters

Response Result Type

Description

msgout

Success

Message out.

This is the message returned after the API is executed.

Method: PUT

Path: /request/cancelabsence

Request Parameters	Description
cancelreason	Absence cancellation reason.
comments	Absence comments.
transactionnbr	Absence transaction number.

Response Parameters	Response Result Type	Description
msgout	Success	Message out. This is the message returned after the API is executed.

Response Parameters

Response Result Type

Description

msgout

Success

Message out.

This is the message returned after the API is executed.

Method: GET

Path: /request/calculateduration/{emplid}/{emplrcd}/{pintakenum}/{startdt}/{enddt}

Request Parameters	Description
emplid	Employee ID
emplrcd	Employee record
enddt	Absence end date.
pintakenum	Pin take number
startdt	Absence begin date.

Response Parameters	Response Result Type	Description
durationabs	Success	Absence duration.
durationdays	Success	Absence duration, days.
durationhrs	Success	Absence duration, hours.
msgout	Success	Message out. This is the message returned after the API is executed.
unittype	Success	Absence unit type.

Method: GET

Path: /request/eligibility/{emplid}/{emplrcd}/{pintakenum}/{startdt}/{enddt}

Request Parameters	Description
emplid	Employee ID
emplrcd	Employee record
enddt	Absence end date.
pintakenum	Pin take number
startdt	Absence begin date.

Response Parameters	Response Result Type	Description
fcstvalue	Success	Forecast value.
msgout	Success	Message out. This is the messag e returned after the API is executed.

Response Parameters

Response Result Type

Description

fcstvalue

Success

Forecast value.

msgout

Success

Message out.

This is the messag e returned after the API is executed.

Method: GET

Path: /request/absencerequests/{emplid}/{emplrcd}/{fromdate}/{todate}

Request Parameters	Description
emplid	Employee ID.
emplrcd	Employee record.
fromdate	Absence from date
todate	Absence to date

Response Parameters	Response Result Type	Description
absName	Success	Absence name (for example, Vacation, Sick, and so forth).
absencereason	Success	Absence reason.
canceloption	Success	Cancel option.
comments	Success	Absence request comments.
country	Success	Country.
enddt	Success	Absence end date.
pintakenum	Success	Pin take number.
quantity	Success	Quantity.
requestdate	Success	Absence request date.
requestenddate	Success	Absence request end date.
requestor	Success	Absence requestor.
startdt	Success	Absence begin date.
statuscode	Success	Absence status code.
transactionnbr	Success	Absence transaction number.
workflowStatus	Success	Workflow status.

Method: GET

Path: /request/absencerequests/{emplid}/{emplrcd}/{fromdate}/{todate}/{absencename}/{wfstatus}

Request Parameters	Description
absencename	Absence name.
emplid	Employee ID.
emplrcd	Employee record.
fromdate	Absence from date.
todate	Absence to date.
wfstatus	Workflow status.

Response Parameters	Response Result Type	Description
absName	Success	Absence name (for example, Vacation, Sick, and so forth).
absencereason	Success	Absence reason.
canceloption	Success	Cancel option.
comments	Success	Absence request comments.
country	Success	Country.
enddt	Success	Absence end date.
pintakenum	Success	Pin take number.
quantity	Success	Quantity.
requestdate	Success	Absence request date.
requestenddate	Success	Absence request end date.
requestor	Success	Absence requestor.
startdt	Success	Absence begin date.
statuscode	Success	Absence status code.
transactionnbr	Success	Absence transaction number.
workflowStatus	Success	Workflow status.

Method: GET

Path: /request/cancelrequests/{emplid}/{emplrcd}/{fromdate}/{todate}

Request Parameters	Description
emplid	Employee ID.
emplrcd	Employee record.
fromdate	Absence from date.
todate	Absence to date.

Response Parameters	Response Result Type	Description
absName	Success	Absence name (for example, Vacation, Sick, and so forth).
absencereason	Success	Absence reason.
canceloption	Success	Cancel option.
comments	Success	Absence request comments.
country	Success	Country.
enddt	Success	Absence end date.
pintakenum	Success	Pin take number.
quantity	Success	Quantity.
requestdate	Success	Absence request date.
requestenddate	Success	Absence request end date.
requestor	Success	Absence requestor.
startdt	Success	Absence begin date.
statuscode	Success	Absence status code.
transactionnbr	Success	Absence transaction number.
workflowStatus	Success	Workflow status.

Method: GET

Path: /request/cancelrequests/{emplid}/{emplrcd}/{fromdate}/{todate}/{absencename}/{wfstatus}

Request Parameters	Description
absencename	Absence name.
emplid	Employee ID.
emplrcd	Employee record.
fromdate	Absence from date.
todate	Absence to date.
wfstatus	Workflow status.

Response Parameters	Response Result Type	Description
absName	Success	Absence name (for example, Vacation, Sick, and so forth).
absencereason	Success	Absence reason.
canceloption	Success	Cancel option.
comments	Success	Absence request comments.
country	Success	Country.
enddt	Success	Absence end date.
pintakenum	Success	Pin take number.
quantity	Success	Quantity.
requestdate	Success	Absence request date.
requestenddate	Success	Absence request end date.
requestor	Success	Absence requestor.
startdt	Success	Absence begin date.
statuscode	Success	Absence status code.
transactionnbr	Success	Absence transaction number.
workflowStatus	Success	Workflow status.

Method: GET

Path: /request/url/{emplid}/{emplrcd}/{pintakenum}/{startdt}/{enddt}/{portal}/{node}/{market}

Request Parameters	Description
emplid	Employee ID.
emplrcd	Employee record.
enddt	Absence end date.
market	Market name of the component (used in generating a PeopleSoft URL).
node	Node name (used in generating a PeopleSoft URL).
pintakenum	Pin take number.
portal	Portal name in the PeopleSoft URL.
startdt	Absence begin date.

Response Parameters	Response Result Type	Description
msgout	Success	Message out. This is the message returned after the API is executed.
url	Success	PeopleSoft URL for the absence request page.

Response Parameters

Response Result Type

Description

msgout

Success

Message out.

This is the message returned after the API is executed.

url

Success

PeopleSoft URL for the absence request page.

API resource to retrieve employee absence balance information.

Method GET

Path: /balance/{emplid}/{emplrcd}

Request Parameters	Description
emplid	Employee ID
emplrcd	Employee record

Response Parameters	Response Result Type	Description
asofdate	Success	Absence balance as of date.
balance	Success	Absence balance.
balancestring	Success	Absence balance string.
entbalname	Success	Absence entitlement balance name.
entbalnbr	Success	Absence entitlement balance number.
msgout	Success	Message out. This is the message returned after the API is executed.
unittype	Success	Unit type for absence balance (days, hours).

Method: GET

Path: /balance/{emplid}/{emplrcd}/{pintakenum}

Get the employee's current absence balance for the given absence type.

Request Parameters	Description
emplid	Employee ID.
emplrcd	Employee record.
pintakenum	Pin take number.

Response Parameters	Response Result Type	Description
asofdate	Success	Absence balance as of date.
balance	Success	Absence balance.
balancestring	Success	Absence balance string.
entbalname	Success	Absence entitlement balance name.
entbalnbr	Success	Absence entitlement balance number.
msgout	Success	Message out. This is the message returned after the API is executed.
unittype	Success	Unit type for absence balance (days, hours).

Method: GET

Path: /balance/{emplid}/{emplrcd}/{pintakenum}/{fcstdate}

Get the employee's future absence balance for the given absence type.

Request Parameters	Description
emplid	Employee ID.
emplrcd	Employee record.
fcstdate	Forecast date.
pintakenum	Pin take number.

Response Parameters	Response Result Type	Description
asofdate	Success	Absence balance as of date.
balance	Success	Absence balance.
balancestring	Success	Absence balance string.
entbalname	Success	Absence entitlement balance name.
entbalnbr	Success	Absence entitlement balance number.
msgout	Success	Message out. This is the message returned after the API is executed.
unittype	Success	Unit type for absence balance (days, hours).

API resource to retrieve absence configuration information, which was set up in Absence Management. Configuration information includes rules and input fields applicable for a particular absence type.

Method: GET

Path: /configuration/absencetakes/{emplid}/{emplrcd}/{asofdate}/{transtype}/{absencename}

Request Parameters	Description
absencename	Absence name.
asofdate	Absence as of date.
emplid	Employee ID.
emplrcd	Employee record.
transtype	The transaction type (B - Balance or R - Request).

Response Parameters	Response Result Type	Description
allowpartialdays	Success	Allow partial days.
description	Success	Description.
fcstRequired	Success	Forecast required.
partialdaysoptn	Success	Partial days option.
pintakenum	Success	Pin take number.

Method: GET

Path: /configuration/absencereasons/{emplid}/{emplrcd}/{pintakenum}/{asofdate}

Request Parameters	Description
asofdate	Absence as of date.
emplid	Employee ID.
emplrcd	Employee record.
pintakenum	Pin take number.

Response Parameters	Response Result Type	Description
absencereason	Success	Reason for absence.
description	Success	Description.

Method: GET

Path: /configuration/cancelreasons/{emplid}/{emplrcd}/{pintakenum}/{asofdate}

Request Parameters	Description
asofdate	Absence as of date.
emplid	Employee ID.
emplrcd	Employee record.
pintakenum	Pin take number.

Response Parameters	Response Result Type	Description
cancelreason	Success	Reason for absence cancellation.
description	Success	Description.

Method: GET

Path: /configuration/userfields/{emplid}/{emplrcd}/{pintakenum}/{startdt}

Request Parameters	Description
emplid	Employee ID.
emplrcd	Employee record.
pintakenum	Pin take number.
startdate	Begin date.

Response Parameters	Response Result Type	Description
label	Success	User field label. This information comes from the absence configuration, which was set up in Absence Management.
msgout	Success	Message out. This is the message returned after the API is executed.
required	Success	User field required flag. This information comes from the absence configuration, which was set up in Absence Management.
seqnum	Success	User field sequence number. This information comes from the absence configuration, which was set up in Absence Management.
type	Success	User field type (character, number, date). This information comes from the absence configuration, which was set up in Absence Management.

API resource to validate absence information that was input by a user when they created an absence request.

Method: GET

Path: /validation/absencename/{emplid}/{emplrcd}/{asofdate}/{absencenam e}

Request Parameters	Description
absencename	Absence name
asofdate	Absence as of date.
emplid	Employee ID.
emplrcd	Employee record.

Response Parameters	Response Result Type	Description
allowpartialdays	Success	Allow partial days.
description	Success	Description.
fcstRequired	Success	Forecast required.
partialdaysoptn	Success	Partial days option.
pintakenum	Success	Pin take number.

Method: GET

Path: /validation/forecastdate/{emplid}/{emplrcd}/{fcstdate}

Request Parameters	Description
emplid	Employee ID.
emplrcd	Employee record.
fcstdate	Forecast date.

Response Parameters	Response Result Type	Description
finalizedprdenddt	Success	Finalized period end date.

API resource to retrieve employee information.

Method: GET

Path: /employee/jobs/{emplid}

Request Parameters	Description
emplid	Employee ID.

Response Parameters	Response Result Type	Description
emplrcd	Success	Employee record.
jobtitle	Success	Employee job title.

Understanding REST API Endpoints for PeopleSoft Absence Management Application Services (absence)

API Resources Used With the PeopleSoft Absence API

request

Method: POST

Method: PUT

Method: GET

Method: GET

Method: GET

Method: GET

Method: GET

Method: GET

Method: GET

balance

Method GET

Method: GET

Method: GET

configuration

Method: GET

Method: GET

Method: GET

Method: GET

validation

Method: GET

Method: GET

employee

Method: GET