Summary

The Workers - Biological Data Management API Guide for eXpert Brazil describes how your application can manage different changes in the worker personal biological data.  It helps you to determine which use case best meets your business needs.

It also guides you through the implementation of each use case.

A worker is a person who performs duties and responsibilities for an organization. In that capacity, a worker fills one or more positions through a work assignment. For a given work assignment, a worker is related to the organization as an employee.

What´s new in this guide

In this section, we will announce any new revisions to the Worker Lifecycle Management Application Programming Interface (API) and this guide.

March, 2023

• First revision of this document

Required setup steps

There are no required setup steps.

Postman collections

Postman allows you to import a collection of APIs, created by others, so you can try them out. For more information on Postman, see Making your first API Call Using Postman

Before you begin

ADP provides a comprehensive set of worker APIs to stay in synch with an ADP application and do the following:

• Update a worker birth date.
• Update a worker gender.

This guide describes the data for eXpert Brazil, with the specific fields accordling to the country specific information and eSocial program.

The amount of data retrieved by your application may vary based on the target ADP system and the ADP system configurations. Additionally, API controls are in place allowing you to filter the requested data based on your needs.

Application Scope

The following canonical needs to be added to your application scope to enable this use case:

/hr/workerInformationManagement/workerManagement/associateManagement/worker.birthdate.change

API Usage

This API allows you to update the worker's birth date in the eXpert system, sending the new date to be considered by the eXpert system. As this is a mandatory information, there's no add or remove operations.

API Tables

The following describes how the tables are set-up:

• ADP eXpert Brazil Field Name – Lists the field where you can use the API to perform an insert, update, and/or delete operation using the POST method.
• Operation - Lists the operation provided for this URI.
• Application Scope – Lists the canonical ID.
• API and Event Type – Lists the URI for the request.
• GitHub Sample Payloads – Provides the location where the sample request and response payloads are posted.

Application Scope

The following canonical needs to be added to your application scope to enable this use case:

/hr/workerInformationManagement/workerManagement/associateManagement/worker.gender.change

API Usage

This API allows you to update the worker's gender in the eXpert system, sending the new gender (M or F) to be considered by the eXpert system. As this is a mandatory information, there's no add or remove operations.

API Tables

The following describes how the tables are set-up:

• ADP eXpert Brazil Field Name – Lists the field where you can use the API to perform an insert, update, and/or delete operation using the POST method.
• Operation - Lists the operation provided for this URI.
• Application Scope – Lists the canonical ID.
• API and Event Type – Lists the URI for the request.
• GitHub Sample Payloads – Provides the location where the sample request and response payloads are posted.

Appendix A: Worker Birth Date Change POST Data Dictionary

The data dictionary provides the schema resource to application user interface field mapping.

Events

Events > Data > Event Context > Worker

Events > Data > Transform > Worker > Person

Appendix B: Worker Gender Change POST Data Dictionary

The data dictionary provides the schema resource to application user interface field mapping.

Events

Events > Data > Event Context > Worker

Events > Data > Transform > Worker > Person