Summary

The Time Off Balances Application Programming Interface (API) is used to view time off balances for an employee or a team.

What's New in this Guide?

In this section, we will announce any new revisions to the Time Off Balances Application Programming Interface (API) and this guide.

November 2020

The first revision of the document

Process Overview

The following table shows how your data connector application would be used by a client.  

Required Setup Steps

There are no required setup steps.

Postman Validation

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.

User Case Description

The Time Off Balances is used to fetch the details of all the Time Off Balances for a specific employee

API Usage

Application Scope

The canonical URI corresponding to the API needs to be added in the Consumer Application Registry (CAR) for the subscription following which a user can access this API and make successful API calls.

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

• /time/timeLaborManagement/timeOffManagement/timeOffBalancesManagement/timeOffBalance.read.

Request End Point Parameters

Request Header Information

There are no request header parameters, in addition to the ADP standard header parameters.

Supported OData Query Options 

There is no support for OData parameters.

Data Entitlement

Is important to consider that the API results are bound to the consumer's rights and population. These rights define the reach of the visible fields in the JSON obtained in a GET method. In a POST method, the data to be sent is, again, bound to consumer’s rights.

Every consumer is part of a population where he has the right to access associate’s data. If the request is being made for an associate that doesn`t belong to the population then an error response will be returned

Sequence of interactions

The following are the steps to retrieve the Time Off Balances information:

1. Your consumer application requests to the ADP API endpoint to GET the time off balances information.
2. The ADP API endpoint responds to your consumer application with time off balances information according to the data entitlement.

Data Dictionary

See Appendix A: Data Dictionary

All listed fields are supported for this use case.

Responses

You may encounter exceptions outside your common success scenarios. You must account for these exceptions during your initial development.

For more information, see API Common Exceptions and Tips for Handling.

Appendix A: Data Dictionary

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