What's New: API Release - September 2017



We are pleased to announce some important changes and services in this month's release...

Introducing Model Domains

Ultimate is restructuring our API solution/project structure to be domain based.

The primary goal is to standardize API URL ‘domain paths’ around Ultimate’s key domains (based on DDD- Domain Driven Design and bounded context considerations), and then organize our codebase along these boundaries. Structuring the codebase & URLs in this way will allow us to gain all the key benefits of DDD. This will also allow us to perform minor releases or hot-fixes with good code isolation and less impact to you our valued customers. 

UltiPro Standard Model Domains

/configuration
/personnel
/payroll
/tax
/talent
/time

*Note: These new domains will be affecting new endpoints only and not have any impact on existing like SOAP services, third party pay, etc...

New service endpoints

We have exposed a few Employee and Configuration endpoints for our Customers and Partners to consume:

  • /employee-ids : This service resides in the /personnel domain and uses Basic Auth for authentication. This service will allow you to look up an UltiPro employee Id and company Id. This service will be useful for looking up these values because they are often unique identifiers for many other service endpoints. Please see our documentation section for more details on all of the types of identifiers you can use to lookup the employee Id's and company id's.
  • /employee-changes : This service also resides in the /personnel domain and uses Basic Auth for authentication. This service will allow you to see all of your employee's attribute changes within a specific time span that you can control with query parameters. To see all the attributes included, please reference our documentation section.
  • /org-levels : This service resides in the /configuration domain and uses Basic Auth for authentication. This service will allow you to add, edit and view your company's organizational level configurations.
  • /code-tables : This service resides in the /configuration domain and uses Basic Auth for authentication. This service will allow you to look up all of the code tables and codes within UltiPro that populate various form drop down menus.