CDL to EDP - Common Good API
Migration Change Log
How to migrate from current CDL APIs to the new EDP Common Good APIs
Embedded Files
CDL to EDP - Common Good API
How to use this page
How to use this page
To the right you will see a table of contents of our original Common Good API offerings. You can click on the API name to navigate to the changes you need to be aware of for the given API. If an API isn't present, it is because we have yet to begin migrating that API.
Below is an At-a-Glance table for each of our APIs for quick reference. If the table says "review endpoint changes" as a required developer action, you can review those endpoint level changes within the relevant API section farther down this page. Finer details on what has changed for a given endpoint may require navigation to our API Design documents which have also been linked to in each section.
Affiliation Information
Affiliation Information
Affiliation Information is being split into two separate APIs: one for Employee Affiliations and one for Student Affiliations to better account for the two distinct use cases for which this API tends to be used. Field and object names in JSON response profiles and request profiles have been adjusted for increased field clarity.
All changes mentioned in the At-A-Glance table and Change Log sections can be seen in more detail in the EDP API Design Document(s) linked at the bottom of this section. The API Design Documents contain the name and definitions for each API and endpoint, the lineage of each field element in the response profile, test cases demonstrating the JSON request and response profiles, and the SQL used to generate each endpoint.
At-A-Glance Endpoint Changes
Change Log
API
Split into two APIs: Employee Affiliations and Student Affiliations
API description reworded for clarity
JSON Request Body and Response Bod
/activeEmployeeByHRDeptid
Endpoint renamed to /activeEmployeesByHRDepartmentId
Endpoint description reworded for clarity
Request profile:
Object wrapper renamed from currentEmployeesAffiliation to departmentIds
deptId field renamed to departmentId
Response profile:
persId field renamed to personId
vPAdminUnit field renamed to vpAdminUnit
New field: collegeAdminUnit
/activeEmployees
Endpoint description reworded for clarity
Response profile:
persId field renamed to personId
/activeEmployeesByZdeptid
Endpoint renamed to /activeEmployeesByZDepartmentId
Endpoint description reworded for clarity
Request profile:
Object wrapper renamed from zDeptids to zDepartmentIds
zDeptid field renamed to zDepartmentId
Response profile:
persId field renamed to personId
vPAdminUnit field renamed to vpAdminUnit
/currentStudentByCampus
Moved to future Student Affiliations API. Student Affiliations is a work in progress.
Link to new EDP API Design Document(s)
Student Affiliations API Design - WIP
Employee Information
Employee Information
Employee Information has been merged with HR Information to create the Workforce and Employment API. Field and object names in JSON response profiles and request profiles have been adjusted for increased field clarity.
All changes mentioned in the At-A-Glance table and Change Log sections can be seen in more detail in the EDP API Design Document(s) linked at the bottom of this section. The API Design Documents contain the name and definitions for each API and endpoint, the lineage of each field element in the response profile, test cases demonstrating the JSON request and response profiles, and the SQL used to generate each endpoint.
At-A-Glance Endpoint Changes
Change Log
API
Employee Information API renamed to Workforce and Employment
API description reworded for clarity
/employeeJobPositionInformation
Endpoint renamed to /jobs
Endpoint description reworded for clarity
Request profile:
Object wrapper renamed from employee to employees
jobType field renamed to jobTypeCode
emplIdinternetId field renamed to emplIdInternetId (note the capitalized "I" in InternetId)
Response profile:
Object wrapper renamed from multipleEmployeeJobPositionInfo to employees
Position object renamed to jobs
recordEffectiveDate changed to return date in YYYY-MM-DD format
jobCodeStartDate changed to return date in YYYY-MM-DD format
expectedAppointmentEndDate changed to return date in YYYY-MM-DD format
primaryJobIndicator field renamed to isPrimaryJob
companyCode field renamed to taxEntityCode
compensationFrequencyCode field renamed to payFrequencyCode
effectiveDate field renamed to recordEffectiveDate
expectedEndDate field renamed to expectedAppointmentEndDate
payGroupCode field renamed to appointmentDurationCode
personOrganizationCode field renamed to universityRelationshipCode
standardHoursAmount field renamed to standardHours
absenceEnrollmentGroup field renamed to absenceEligibilityGroup
reportsToPosition field renamed to reportsToPositionNumber
New field: jobTypeCode
/employeeSupervisorInformation
Endpoint renamed to /supervisors
Endpoint description reworded for clarity
Request profile:
Object wrapper renamed from employeeSupervisor to employees
jobType field renamed to jobTypeCode
Response profile:
Object wrapper renamed from employee to employees
job object renamed to jobs
New object nested under jobs called supervisor created for supervisor fields
employeeEmpId field renamed to emplid
employeeInternetId field renamed to internetId
employeePrimaryJobIndicator field renamed to isPrimaryJob
employeeStatusCode field renamed to employeeStatusCode
supervisorDepartmentId field renamed to departmentId
supervisorDepartmentName field renamed to departmentName
supervisorEmailAddressIdentifier field renamed to email
supervisorEmplId field renamed to emplId
supervisorFirstName field renamed to firstName
supervisorFullName field renamed to fullName
supervisorInternetId field renamed to internetId
supervisorJobCode field renamed to jobCode
supervisorLastName field renamed to lastName
supervisorMiddleName field renamed to middleName
supervisorPositionNumber field renamed to positionNumber
supervisorPositionTitle field renamed to positionTitle
New field: jobTypeCode
Link to new EDP API Design Document(s)
HR Information
HR Information
HR Information and Employee Information have been merged to create a "Workforce and Employment" API. Some endpoints (namely hrLocaitonCode and hrCountryCode) have been removed due to a lack of subscribers or because the information provided by the endpoint will be provided by other endpoints in the future. Field and object names in JSON response profiles and request profiles have been adjusted for increased field clarity.
All changes mentioned in the At-A-Glance table and Change Log sections can be seen in more detail in the EDP API Design Document(s) linked at the bottom of this section. The API Design Documents contain the name and definitions for each API and endpoint, the lineage of each field element in the response profile, test cases demonstrating the JSON request and response profiles, and the SQL used to generate each endpoint.
At-A-Glance Endpoint Changes
Change Log
API
HR Information endpoints have been moved to the Workforce and Employment API
/hrCountryCode
Removed
/hrJobCode
Endpoint renamed to jobCodes
Endpoint description reworded for clarity
Request profile:
Object wrapper renamed from jobCode to jobCodes
jobCode field renamed to jobCodes
Response profile:
jobCodeGroupDescription field renamed to jobCodeGroupLongDescription
jobFamilyLevelDescription field renamed to jobFamilyLevelLongDescription
workforceCategoryDescription field renamed to workforceCategoryLongDescription
New field: jobFamilyLongDescription
/hrJobEmployeeClass
Endpoint renamed to employeeClasses
Endpoint description reworded for clarity
Request profile:
Object wrapper renamed from people to jobCodes
Response profile:
employeeClassificationCode field renamed to employeeClassCode
employeeClassificationLongDescription field renamed to employeeClassLongDescription
employeeClassificationShortDescription field renamed to employeeClassShortDescription
/hrJobFamilyCode
Endpoint renamed to jobFamilies
Endpoint description reworded for clarity
Request profile:
Object wrapper renamed from jobFamilyCode to jobFamilyCodes
/hrLocationCode
Removed
/hrPersonInformation
Moved to Person Institutional Details API
Endpoint renamed to personComplianceStatuses
Endpoint description reworded for clarity
Request profile:
Object wrapper renamed from people to personComplianceStatuses
Response profile:
safetyOfMinorIndicator field renamed to isSafetyOfMinorsRequired
recentBackgroundCheckDate changed to return date in YYYY-MM-DD format
/hrPositionInformation
Endpoint renamed to positions
Endpoint description reworded for clarity
Request profile:
Object wrapper renamed from people to positionNumbers
Response profile:
departmentIdentifier field renamed to departmentId
jobFamilyDescription field renamed to jobFamilyLongDescription
jobGroupCode field renamed to jobCodeGroupCode
jobGroupCodeDescription field renamed to jobCodeGroupLongDescription
positionShortTitle field renamed to positionTitleAbbreviated
positionTitleDescription field renamed to positionTitle
regOrTemp field renamed to regularOrTemporary
reportsToPosition field renamed to reportsToPositionNumber
standardHoursAmount field renamed to standardHours
New field: departmentName
New field: jobTitle
Link to new EDP API Design Document(s)
Person Address Information
Person Address Information
Person Address Information has been renamed to Person Addresses and has remained largely the same. The most notable change is an added array for the address line fields to all exist within. There have also been small changes to request and response profile field names.
All changes mentioned in the At-A-Glance table and Change Log sections can be seen in more detail in the EDP API Design Document(s) linked at the bottom of this section. The API Design Documents contain the name and definitions for each API and endpoint, the lineage of each field element in the response profile, test cases demonstrating the JSON request and response profiles, and the SQL used to generate each endpoint.
At-A-Glance Endpoint Changes
Change Log
API
Person Address Information API renamed to Person Addresses
API description reworded for clarity
/personAddressInformation
Endpoint renamed to personInstitutionalContacts
Endpoint description reworded for clarity
Request profile:
addressType field renamed to addressTypeCode
person object renamed to personAddresses
emplIdinternetId field renamed to emplIdInternetId (note the capitalized "I" in InternetId)
Response profile:
addressDetail object renamed to addresses
addressLine1 through 4 combined into new lines array
addressType field renamed to addressTypeCode
stateProvinceName field renamed to stateName
Link to new EDP API Design Document(s)
Person Basic Information
Person Basic Information
Person Basic has been renamed to Person Insititutional Details. It's two original endpoints have been merged into one called person institutional contacts. Arrays have been added to house like information (e.g. phones, addresses). A new endpoint has been added to this API, person compliance statuses, which was originally housed in HR Information. As with other APIs, some fields have had their names changed for clarity.
All changes mentioned in the At-A-Glance table and Change Log sections can be seen in more detail in the EDP API Design Document(s) linked at the bottom of this section. The API Design Documents contain the name and definitions for each API and endpoint, the lineage of each field element in the response profile, test cases demonstrating the JSON request and response profiles, and the SQL used to generate each endpoint.
At-A-Glance Endpoint Changes
Change Log
API
Person Basic Information API renamed to Person Institutional Details
API description reworded for clarity
/MultiplePersonCampusContactInformation & /MultiplePersonContactInformation
Endpoint renamed to personInstitutionalContacts
Endpoint description reworded for clarity
Request profile:
Object wrapper renamed from personContact to personInstitutionalContacts
person object renamed to personAddresses
emplIdinternetId field renamed to emplIdInternetId (note the capitalized "I" in InternetId)
Response profile:
New Address object wrapper added for address information.
addressLine1 through 4 combined into new lines array
city field renamed to cityName
state field renamed to StateCode
New field: stateName
New field: addressTypeCode
New field: phoneTypeCode
New Phones object wrapper added for phone information
campusEmailAddress field renamed to campusRoutingEmailAddress
emailAddressIdentifier renamed to universityEmailAddress
Link to new EDP API Design Document(s)
Person Email Address Information
Person Email Address Information
Person Email Address Information has been renamed to Person Email Addresses. The API and its endpoint remain largely unchanged save for many of its data fields being renamed. The preferred email address flag has notably been removed on EDMR's recommendation as it is a system field and does not represent an individual's choice of their preferred email.
All changes mentioned in the At-A-Glance table and Change Log sections can be seen in more detail in the EDP API Design Document(s) linked at the bottom of this section. The API Design Documents contain the name and definitions for each API and endpoint, the lineage of each field element in the response profile, test cases demonstrating the JSON request and response profiles, and the SQL used to generate each endpoint.
At-A-Glance Endpoint Changes
Change Log
API
Person Email Address Information API renamed to Person Email Addresses
API description reworded for clarity
/personEmailAddressInformation
Endpoint renamed to personEmailAddresses
Endpoint description reworded for clarity
Request profile:
emailAddressType field renamed to emailTypeCode
person object renamed to personEmails
emplIdinternetId field renamed to emplIdInternetId (note the capitalized "I" in InternetId)
Response profile:
Object wrapper renamed from personEmailAddresses to personEmails
emailInfo object renamed to emails
personEmailAddress field renamed to emailAddress
personEmailAddressTypeCode field renamed to emailTypeCode
personEmailAddressTypeCodeDesc field renamed to emailTypeLongDescription
employeeId field renamed to emplid
personEmailAddressPreferredFlag field removed
Link to new EDP API Design Document(s)
Person Phone Information
Person Phone Information
Person Phone Information has been renamed to Person Phone Numbers. The API and its endpoint remain largely unchanged save for some of its data fields being renamed.
All changes mentioned in the At-A-Glance table and Change Log sections can be seen in more detail in the EDP API Design Document(s) linked at the bottom of this section. The API Design Documents contain the name and definitions for each API and endpoint, the lineage of each field element in the response profile, test cases demonstrating the JSON request and response profiles, and the SQL used to generate each endpoint.
At-A-Glance Endpoint Changes
Change Log
API
Person Phone Information API renamed to Person Phone Numbers
API description reworded for clarity
/personPhoneInformation
Endpoint renamed to personPhoneNumbers
Endpoint description reworded for clarity
Request profile:
emplIdinternetId field renamed to emplIdInternetId (note the capitalized "I" in InternetId)
Response profile:
Object wrapper renamed from multiplePersonPhoneInfo to personPhones
phoneInfo object renamed to phones
phoneCountryCode field renamed to dialingCountryCode
phoneExtension field renamed to phoneExtension
preferredPhoneIndicator field renamed to isPreferredPhone
Link to new EDP API Design Document(s)
Person Tenure Status
Person Tenure Status
Person Tenure Status has been renamed to Person Tenure Statuses. The API and its endpoint remain largely unchanged save for some of its data fields being renamed and response and request profile structures being altered slightly.
All changes mentioned in the At-A-Glance table and Change Log sections can be seen in more detail in the EDP API Design Document(s) linked at the bottom of this section. The API Design Documents contain the name and definitions for each API and endpoint, the lineage of each field element in the response profile, test cases demonstrating the JSON request and response profiles, and the SQL used to generate each endpoint.
At-A-Glance Endpoint Changes
Change Log
API
Person Tenure Status API renamed to Person Tenure Statuses
API description reworded for clarity
/personTenureStatus
Endpoint renamed to personTenureStatuses
Endpoint description reworded for clarity
Request profile:
Object wrapper renamed from id to personTenureStatuses
emplIdinternetId field renamed to emplIdInternetId (note the capitalized "I" in InternetId)
Response profile:
Object wrapper renamed from personTenureStatus to personTenureStatuses
New "tenures" object added to house tenure information
tenfureFlag field renamed to isTenured
tenureStatusLongDesc field renamed to tenureStatusLongDescription
tenureTrackFlag field renamed to isTenureTrack
tenureStatusShortDescription field removed
Link to new EDP API Design Document(s)
Term Information
Term Information
Term information has been renamed to "Academic Terms". Additionally its various endpoints have been merged into one endpoint, also called "academic terms". The request profile has been adjusted to meet the same needs as each of the old endpoints. Information on using this new endpoint can be found on the API Developer Portal under the endpoint's description. Field names have remained consistent, save for institution code being renamed to campus code.
All changes mentioned in the At-A-Glance table and Change Log sections can be seen in more detail in the EDP API Design Document(s) linked at the bottom of this section. The API Design Documents contain the name and definitions for each API and endpoint, the lineage of each field element in the response profile, test cases demonstrating the JSON request and response profiles, and the SQL used to generate each endpoint.
At-A-Glance Endpoint Changes
Change Log
API
Term Information API renamed to Academic Terms
API description reworded for clarity
/activeTerm, /latestTerm, /soonestTerm, /termByCode, /termByDate,and /termCurrentAndFutureByDate
Endpoints have been merged into one "academicTerms" endpoint.
Information on using the new request profile can be found on the API Developer Portal in the endpoint's description.
Request profile:
institutionCode field renamed to campusCode
date field renamed to asOfDate
asOfDate changed to accept date in YYYY-MM-DD format
Response profile:
institutionCode field renamed to campusCode
termDescription field renamed to termLongDescription
termBeginDate changed to return date in YYYY-MM-DD format
termEndDate changed to return date in YYYY-MM-DD format
New field: academicCareerLongDescription
Link to new EDP API Design Document(s)
Page updated
Report abuse