PayCalendar

Service Information:

Version: 1.0

Availability: Non-Production

Release Date: October 2017

Framework: AITS RESTful Data API

Description: Retrieve Banner payroll calendar data.

Source System: Banner

Operations:

 GET https://webservices.admin.uillinois.edu/employeeWS/data...
      .../{senderAppId}/PayCalendar/1_0/{queryPayYear}/{queryPayId}/{queryPayNumber}?format={format}

Sample Request

GET /employeeWS/data/mySenderAppId/PayCalendar/1_0/2017/BW/1 HTTP/1.1
Host: webservices-dev.admin.uillinois.edu

Data Object Detail:

Functional Area: Employee

Name: PayCalendar

Version:1.0

Element Map (JSON-based):

A table detailing the attributes and elements within the Pay Calendar object

Path	Type	Name	Occurrence	Description
object	Element	object	Exactly One	Identifies the name of the object retrieved.
version	Element	version	Exactly One	Identifies the version of the object retrieved.
list	Object/Array	list	Exactly One	Parent object containing PayCalendar data
list.queryPayYear	Element	queryPayYear	Exactly One	Pay Period Year (from incoming query string)
list.queryPayId	Element	queryPayId	Exactly One	Pay ID (from incoming query string)
list.queryPayNumber	Element	queryPayNumber	Exactly One	Pay Number/Sequence (from incoming query string)
list.payCalendar	Object/Array	payCalendar	Zero or Many	Array of pay calendar events.
list.payCalendar.payPeriod	Object/Array	payPeriod	Exactly One	Object containing the pay period associated with the time entry(ies) returned.
list.payCalendar.payPeriod.payId	Object/Array	payId	Exactly One	Object containing information about a Pay Period ID
list.payCalendar.payPeriod.payId.code	Element	code	Exactly One	Pay Period ID Code
list.payCalendar.payPeriod.payId.description	Element	description	Exactly One	Pay Period ID Description
list.payCalendar.payPeriod.payNumber	Element	payNumber	Exactly One	Pay Period Number/Sequence.
list.payCalendar.startDate	Element	startDate	Zero or Many	The start date of the pay period.
list.payCalendar.endDate	Object/Array	endDate	Exactly One	The end date of the pay period.
list.payCalendar.checkDate	Element	checkDate	Exactly One	The date which will appear on the pay document.
list.payCalendar.payOfMonthSequence	Element	payOfMonthSequence	Exactly One	Indicates the pay of the month.
list.payCalendar.timeEntryStartDate	Element	timeEntryStartDate	Exactly One	Time Entry Start Date
list.payCalendar.timeEntryEndDate	Object/Array	timeEntryEndDate	Exactly One	Time Entry End Date
list.payCalendar.timeEntryCutoffTime	Element	timeEntryCutoffTime	Exactly One	Time Entry Cutoff Time: Time in which data entry terminates.
list.payCalendar.webViewCutoffDate	Element	webViewCutoffDate	Exactly One	Date until which the user has access to view on the web information for the pay period.
list.payCalendar.approvedViewCutoffDate	Object/Array	approvedViewCutoffDate	Exactly One	Date until which the approver has access to view on the web information for the pay period.