Employee API Changes and Updates in TEST

December 13, 2018

This article will be updated after Employee API changes have been deployed to the Test environment.  The following key information is available via this article:  

  • Employee API v3 Updates 
  • Requests/Defects
  • Known Issues

Information about Planned/Actual Deployment opportunities and Technical FAQs are accessible via the following hyperlinks.  

Employee API v3 Updates
Item Description Date Deployed Tracking Number
1

[Employee API]  Querying the new Employee API with a non-existent ID returns a 200 code with an empty response body instead of a 404 code

1/11/2019 UCPTT-295
2

[Employee API]  New fields added to the API:  highest degree earned

1/11/2019 UCPTT-291
3

[Department API] The underlying data source for this API is now switched over to UCPath from HCM.

1/11/2019 UCPTT-304
4

[Position API] New API containing HR Positions and related data.

1/11/2019 UCPTT-306
5

[Employee API]  Need the Expected Job End Date added to the Employee API

1/11/2019 UCPTT-330
6

[Employee API]  VISA info:  Type:  Code, Description, Status:  Code, Description, Entry Date, From Date

                     <p:visa>
                        <d:type>
                            <r:code>F1</r:code>
                            <r:description>Student</r:description>
                        </d:type>
                        <d:status>
                            <r:code>G</r:code>
                            <r:description>Granted</r:description>
                        </d:status>
                        <d:entryDate>2016-08-13</d:entryDate>
                        <d:fromDate>2016-10-28</d:fromDate>
                    </p:visa>
12/13/2018 INC0770820
7 [Employee API]  National ID removed from the Employee API per business decisions 12/13/2018 N/A
8 [Employee API]  Chartfield3 now available in the Employee API 12/13/2018 INC0786794
9 [Employee API]  Fixed EMPL and CWR affiliation mapping multiple Employee rows returned instead of single Employee row with multiple JOB nodes 12/13/2018 UCPTT-303
10 [Job Code API] New fields available.  Working document of mapped fields available here. 12/13/2018 UCPTT-179
11 [Employee API] Need BUDGET_SEQ field added to earning distribution (UCPath source: PS_DEPT_BUDGET_ERN.BUDGET_SEQ)  Added to EmployeeV0.xsd as distributionType.number (integer, required) 12/13/2018 UCPTT-285
12 Allow public access to bmeta 12/6/2018 UCPTT-276
13 [Employee API]   Add Employee VISA data to the API (partial delivery) 11/29/2018 INC0770820
14 [Employee API]  Returning different address fields for some UIDs 11/29/2018 INC0770115
15 [Employee API] Update Interactive Documentation to reflect 500 as the pagination limit instead of 1000. 11/29/2018 UCPTT-268
16

 bMeta updates: 

11/29/2018 UCPTT-280 
17 [Employee API] Data issue with Job Earnings distribution not being returned in specific effective dated cases where an employee has multiple job codes and effective dated data 11/29/2018 INC0777185
18  [Employee API]:  The supervisor record from the Reports To record has the employee ID;  not seeing the UID, and would be nice to include the campus UID as an id-type 11/29/2018 UCPTT-289
19  [Employee API]  Legacy-hr-employee-id only returning preferred (PRF) address types, when both primary (PRI) and preferred (PRF) expected 11/29/2018 UCPTT-292

Requests/Defects

Item Description Who Reported Date Reported

Estimated Date Available

Status Issue Type
1 INC0770820:  [Employee API]   Add Employee VISA APBears 10/30/2018 12/13/2018 Complete Feature
2 INC0770115: [Employee API]  Returning different address fields for some UIDs UHS 11/1/2018 11/29/2018 Complete Defect
3 UCPTT-179:  [Job Codes Position API]   Currently, the Employee API provides an employee's supervising position number;  would also like the ability to extract position data, with a corresponding position number ServiceNow 10/26/2018 12/13/2018 Complete Feature
4 UCPTT-285:   [Employee API] Need BUDGET_SEQ field added to earning distribution (UCPath source: PS_DEPT_BUDGET_ERN.BUDGET_SEQ)  Added to EmployeeV0.xsd as distributionType.number (integer, required) SIS 11/6/2018 12/13/2018 Complete Feature
5

UCPTT-268:  [Employee API] Update Interactive Documentation to reflect 500 as the pagination limit instead of 1000.

Internal 10/23/2018 11/29/2018 Complete Defect
6

UCPTT-280:  bMeta updates: 

Internal 10/31/2018 11/29/2018 Complete Feature
7

INC0777185:  [Employee API] Data issue with Job Earnings distribution not being returned in specific effective dated cases where an employee has multiple job codes and effective dated data. 

APBears 11/15/2018 12/13/2018 Complete Defect/Data
8

UCPTT-289:  [Employee API]:  The supervisor record from the Reports To record has the employee ID;  not seeing the UID, and would be nice to include the campus UID as an id-type.

EHS 11/16/2018 11/29/2018 Complete Feature
9

UCPTT-292:  [Employee API]  Legacy-hr-employee-id only returning preferred (PRF) address types, when both primary (PRI) and preferred (PRF) expected.  

Library 11/21/2018 11/29/2018
Complete Defect
10

UCPTT-291:  [Employee API]  New fields needed for the API:  highest degree earned, and more

ERSO 11/27/2018 1/10/2019 Complete Feature
11

UCPTT-294:  [Employee API]  Add an Employee API endpoint allowing the ability to query by certain job attributes (e.g., "Job type = Faculty", "Job classification = Academic", "Job status = Active",etc.) to return a collection of Employees.

EECS 11/28/2018 TBD In Progress Feature
12

UCPTT-295:  [Employee API]  Querying the new Employee API with a non-existent ID returns a 200 code with an empty response body instead of a 404 code

EECS 11/28/2018 1/10/2019 Complete Defect
13

UCPTT-276:  Allow public access to bmeta

AP Bears 9/27/2018 12/6/2018 Complete Feature
14

INC0786794:  Add ChartString3 to the API response

AP Bears 12/6/2018 12/13/2018 Complete Feature
15

UCPTT-303:  [Employee API]  On the /v3/employees/{id}/jobs enpoint, sometimes there are multiple <emp:employee> nodes for just one employee when an employee has multiple affiliations (CWR and employee).  Expectation is to to see one employee record with multiple JOB rows, some of which could be CWR rows.

SAIT 12/7/2018 12/13/2018 Complete Defect
16

UCPTT-330:  [Employee API]  Need the Expected Job End Date added to the Employee API

Library 1/10/2019 1/11/2018 Complete Feature 

Known Issues
Item Description
1 The API only shows the converted data as of a May 2018 Production snapshot, during the UCPath TEST phase.  A more recent Production snapshot will be available during the UCPath UAT phase.