Use Case: Worker Management Code Lists

Summary

This use case lists all the code lists in the Validation tables related to worker management.

Application Scope

The following canonical needs to be added to your application scope to enable the API's listed in the following section:

/hr/workerInformationManagement/workerManagement/codeListViewing/codelist.read

API Usage

State/Province/Territory Address API

This list is defined for all clients and it should be listed when assigning the State/Province/Territory to an employee address based on the country code selected.

Method

URI

Description

GitHub Sample Response Payload

GET /codelists/hr/v4/worker-management/state-province-territory/wfn/1 List of State/Province/Territory values. get-State:Province:Territory-address-CodeList-http-200-response.json

Workers Compensation Statuses API

The client practitioner can view the Workers Compensation Statuses codes in the ADP Workforce Now UI by selecting Process > HR > Hire/rehire > New Hire Template > Tax Section > Tax More fields > Workers Compensation Statuses code.

Method

URI

Description

GitHub Sample Response Payload

GET /codelists/hr/v4/worker-management/worker-compensation-status/wfn/1 Specifies the Workers Compensation Statuses. Get-company-CodeList-http-200-response.json

Workers Compensation Type API

The client practitioner can view Workers compensation type in the ADP Workforce Now UI by selecting Process > HR > Hire/rehire > New Hire Template > Tax Section > Tax More fields > Workers compensation type.

Method

URI

Description

GitHub Sample Response Payload

GET /codelists/hr/v4/worker-management/worker-compensation-type/wfn/1 Specifies the Workers Compensation Types. get-worker-compensation-type-CodeList-http-200-response.json

Workers Compensation Job Class Code API

The client practitioner can view the Workers compensation Job class code in the ADP Workforce Now UI by selecting Process > HR > Hire/rehire > New Hire Template > Tax Section > Tax More fields > Workers compensation Job class code.

Method

URI

Description

GitHub Sample Response Payload

GET /codelists/hr/v4/worker-management/worker-compensation-job-class/wfn/1 Specifies the Workers compensation Job class code. get-worker-compensation-type-CodeList-http-200-response.json

Workers Compensation Class Code Type Code API

The client practitioner can view the Workers Compensation Class Code Type in the ADP Workforce Now UI by selecting Process > HR > Hire/rehire > New Hire Template > Tax Section > Tax More fields > Workers Compensation Class Code Type.

Method

URI

Description

GitHub Sample Response Payload

GET /codelists/hr/v4/worker-management/worker-compensation-class-code-type/wfn/1 Specifies the Workers Compensation Class Code Type code List. get-worker-compensation-class-code-type-code-CodeList-http-200-response.json

Languages API

The client practitioner can view the Language in ADP Workforce Now by selecting Setup > Tools > Validation Tables > Languages > Language.

Method

URI

Description

GitHub Sample Response Payload

GET /codelists/hr/v4/worker-management/languages/wfn/1 Specifies the Language. Get-languages-CodeList-http-200-response.json

Equal Employment Opportunity (EEO) Establishments API

The client practitioner can manage the EEO Establishment in ADP Workforce Now UI by selecting Setup > Tools > Validation Tables > Employment Profile > Position > EEO Establishment.

Method

URI

Description

GitHub Sample Response Payload

GET /codelists/hr/v4/worker-management/eeo-establishments/wfn/1 Specifies the EEO Establishments. Get-EEO-CodeList-http-200-response.json

North American Industry Classification System (NAICS) Workers Comp API

The client practitioner can manage the NAICS Workers Comp in ADP Workforce Now by selecting Setup > Tools > Validation Tables > Position > NAICS Workers Comp.

Method

URI

Description

GitHub Sample Response Payload

GET /codelists/hr/v4/worker-management/naics-worker-compensation/wfn/1 Specifies the NAICS Workers' Comp. Get-NAICS-CodeList-http-200-response.json

Onboarding Experiences API

The client practitioner can manage onboarding experiences in the ADP Workforce Now UI by selecting Setup > HR & Talent > Manage Onboarding.

Method

URI

Description

GitHub Sample Response Payload

GET /codelists/hr/v4/worker-management/onboard-experience/wfn/1 Specifies the management of the onboarding experience. Get-onboard-experience-CodeList-http-200-response.json

E-Verify Work Locations API

The client practitioner can manage the E-Verify Work Locations in the ADP Workforce Now UI by selecting Process > Hire/Rehire > Employment > E-Verify Work Location.

Method

URI

Description

GitHub Sample Response Payload

GET /codelists/hr/v4/worker-management/e-verify-work-locations/wfn/1 Specifies the E-Verify Work Locations. Get-e-verify-work-location-CodeList-http-200-response.json

Worker Category API

The client practitioner can manage worker categories in the ADP Workforce Now UI by selecting Setup > Validation Tables > Employment Profile > Employment > Worker Category.

Method

URI

Description

GitHub Sample Response Payload

GET /codelists/hr/v4/worker-management/worker-category/wfn/1 Specifies the Worker Categories. Get-worker-category-CodeList-http-200-response.json

Countries API

The list of countries is static for all clients.

Method

URI

Description

GitHub Sample Response Payload

GET /codelists/hr/v4/worker-management/countries/wfn/1 Specifies the list of countries. Get-country-CodeList-http-200-response.json

Status Change Reasons API

The client practitioner can manage Status Change Reasons in the ADP Workforce Now UI by selecting Setup > Validation Tables > Employment Profile > Status > Status Change Reasons.

Method

URI

Description

GitHub Sample Response Payload

GET /codelists/hr/v4/worker-management/status-change-reason/wfn/1 Specifies the Status Change Reasons.

Get-status-change-reson-CodeList-http-200-response.json
 

GET /codelists/hr/v4/worker-management/status-change-reason/wfn/1?$filter=category eq 'Place on Leave' Specifies the Status Change Reasons for given category.  

Chinese ethnic group API

The client practitioner can view Company Codes in the ADP Workforce Now UI by selecting New Hire > Personal Step > Demographic section > “More fields” > Ethnic Group

Only visible on the hire screen when hiring an international employee to the country code of China. It is not user defined but a required field for hiring employees in china.

 

Method

URI

Description

GitHub Sample Response Payload

GET

/hr/v4/worker-management/chinese-ethnic-groups/wfn/1

List of Chinese ethnic group Codes.

Get-chinese-ethnic-group-CodeList-http-200-response.json
 

Marital Status API

The client practitioner can manage Marital Status in the ADP Workforce Now UI by selecting Setup > Tools > Validation Tables > Personal Information > Marital Status.

There is no ability for users to add marital status to a country explicitly and the available marital status on the New Hire screen is controlled by ADP.

Method

URI

Description

GitHub Sample Response Payload

Note

GET /codelists/hr/v4/worker-management/marital-status/wfn/1 List of Marital Statuses. Get-Marital-status-codeList-http-200-response.json

When no country code is passed it is pulling the list from Validation Tables > Personal Information > Marital Status.

This list does not have any country parameter and is the full list of codes in the ADP Workforce Now client.

This is the reason category is blank.

 

GET /codelists/hr/v4/worker-management/marital-status/wfn/1?$filter=category eq 'CH'

Retrieves list of marital statuses for

the specified country code.

Get-Marital-status-countryCode-filter-codeList-http-200-response.json
 

You can get different country codes by calling the country codes codelist API.

/codelists/hr/v4/worker-management/countries/wfn/1