TimeEntry
Service Information:
Version: 1.0
Availability: Non-Production
Release Date: October 2017
Framework: AITS RESTful Data API
Description: Retrieve Banner time sheet entries for reconciliation with time entry systems that are maintained at the unit level.
Source System: Banner
Operations:
GET https://webservices.admin.uillinois.edu/employeeWS/data...
.../{senderAppId}/TimeEntry/1_0/{queryUin}/{queryPayYear}/{queryPayId}/{queryPayNumber}/{queryTSCoasCode}/{queryTSOrgnCode}?format={format}
| Parameter | Description | Type | Required |
|---|---|---|---|
| senderAppId | Authorized sender application ID. | String | Yes |
| queryUIN | University Identification Number (UIN) for subject to be queried. | String | Yes |
| queryPayYear | Pay Period Year | String | Yes |
| queryPayId | Pay Period ID (e.g. "MN", "BW") | String | Yes |
| queryPayNumber | Pay Period Number/Sequence | String | Yes |
| queryTSCoasCode | Time Sheet Chart of Accounts Code associated with the time entry. | String | Yes |
| queryTSOrgnCode | Time Sheet Organization Accounts Code associated with the time entry. | String | Yes |
| format | Desired response format. Supports either "json" (default) or "xml". | String | No |
Sample Request
GET /employeeWS/data/mySenderAppId/TimeEntry/1_0/123456/2017/BW/1/1/123456?format=json HTTP/1.1
Host: webservices-dev.admin.uillinois.edu
Data Object Detail:
Functional Area: Employee
Name:TimeEntry
Version:1.0
Element Map (JSON-based):
| 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 Time Entry data |
| list.queryUin | Element | queryUin | Exactly One | University Identification Number (from incoming query string) |
| 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.queryTSCoasCode | Element | address | Exactly One | Time Sheet Chart of Accounts Code (from incoming query string) |
| list.queryTSOrgnCode | Element | queryTSOrgnCode | Exactly One | Time Sheet Organization Code (from incoming query string) |
| list.payPeriod | Object/Array | payPeriod | Exactly One | Object containing the pay period associated with the time entry(ies) returned. |
| payPeriod.payId | Object/Array | payId | Exactly One | Object containing information about a payroll ID |
| payPeriod.payId.code | Element | code | Exactly One | Pay Period ID Code |
| payPeriod.payId.description | Element | description | Exactly One | Pay Period ID Description |
| payPeriod.payNumber | Element | payNumber | Exactly One | Pay Period Number/Sequence. |
| timeEntry | Object/Array | timeEntry | Zero or Many | Array of time entries |
| timeEntry.jobAssignment | Object/Array | jobAssignment | Exactly One | Object containing data about the job assignment associated with a time entry. |
| timeEntry.jobAssignment.pidm | Element | pidm | Exactly One | Internal (Banner) identification number of the person. |
| timeEntry.jobAssignment.positition | Element | positition | Exactly One | Position Number of the Assignment. |
| timeEntry.jobAssignment.suffix | Element | suffix | Exactly One | Suffix of the Assignment. |
| timeEntry.jobAssignment.timeSheetChartOfAccounts | Object/Array | timeSheetChartOfAccounts | Exactly One | Object containing information about a chart of accounts code |
| timeEntry.jobAssignment.timeSheetChartOfAccounts.code | Element | code | Exactly One | Time sheet chart of accounts code |
| timeEntry.jobAssignment.timeSheetChartOfAccounts.description | Element | description | Exactly One | Time sheet chart of accounts description |
| timeEntry.jobAssignment.timeSheetOrganization | Object/Array | timeSheetOrganization | Exactly One | Object containing information about an organization code |
| timeEntry.jobAssignment.timeSheetOrganization.code | Element | code | Exactly One | Time Sheet Organization Code |
| timeEntry.jobAssignment.timeSheetOrganization.description | Element | description | Exactly One | Time Sheet Organization Code Description |
| timeEntry.jobAssignment.title | Element | title | Exactly One | Job Title |
| timeEntry.jobAssignment.shift | Element | shift | Exactly One | Job Shift |
| timeEntry.jobAssignment.defaultHours | Element | defaultHours | Exactly One | Number of hours defaulted during initial time extract. |
| timeEntry.jobAssignment.employeeClass | Object/Array | employeeClass | Exactly One | Object containing information about an employee class |
| timeEntry.jobAssignment.employeeClass.code | Element | code | Exactly One | Employee class code |
| timeEntry.jobAssignment.employeeClass.description | Element | description | Exactly One | Employee class description |
| timeEntry.jobAssignment.approvalCategory | Object/Array | approvalCategory | Exactly One | Object containing information about an approval category |
| timeEntry.jobAssignment.approvalCategory.code | Element | code | Exactly One | Approval category code |
| timeEntry.jobAssignment.approvalCategory.description | Element | description | Exactly One | Approval category description |
| timeEntry.jobAssignment.leaveCategory | Object/Array | leaveCategory | Exactly One | Object containing information about a leave category |
| timeEntry.jobAssignment.leaveCategory.code | Element | code | Exactly One | Leave category code |
| timeEntry.jobAssignment.leaveCategory.description | Element | description | Exactly One | Leave category description |
| timeEntry.action | Object/Array | action | Exactly One | Object containing information about a time entry action |
| timeEntry.action.code | Element | code | Exactly One | Time sheet action indicator |
| timeEntry.action.description | Element | description | Exactly One | Time sheet action description |
| timeEntry.status | Object/Array | status | Exactly One | Object containing information about a time entry's status |
| timeEntry.status.code | Element | code | Exactly One | Time entry status code |
| timeEntry.status.description | Element | description | Exactly One | Time entry status description |
| timeEntry.method | Object/Array | method | Exactly One | Object containing information about a time entry method |
| timeEntry.method.code | Element | code | Exactly One | Time entry method code |
| timeEntry.method.description | Element | description | Exactly One | Time entry method description |
| timeEntry.type | Object/Array | type | Exactly One | Object containing information about a time entry type |
| timeEntry.type.code | Element | code | Exactly One | Time entry type code |
| timeEntry.type.description | Element | description | Exactly One | Time entry type description |
| timeEntry.earningsType | Object/Array | type | Exactly One | Object containing information about an earnings type |
| timeEntry.earningsType.code | Element | code | Exactly One | Earnings type code |
| timeEntry.earningsType.description | Element | description | Exactly One | Earnings type description |
| timeEntry.specialRate | Element | specialRate | Exactly One | Special rate for earnings. |
| timeEntry.entryDate | Element | entryDate | Exactly One | Date of the hours breakdown. |
| timeEntry.hours | Element | hours | Exactly One | Number of hours associated with the Earning Code. |