Importing rostering data via API

Rostering API facilitates the seamless upload and asynchronous import of CSV files containing data related to users, batteries, groups, and sessions into the Portal application. Additionally, this document provides details on how to use the status endpoint to monitor the progress and success of a data import, and how to download the results of this imports.

Authentication

To use the endpoint(s), customers must authenticate by providing a valid Bearer token in the Authorization header:

1. This token can be obtained from the Auth Server at https://{TAO_ADVANCE_URL}/api/v1/upload/v1/oauth2/tokens using the client_credentials grant type and a client_id/client_secret combination.

2. This returns a token with the rostering scope.

For the necessary credentials, customers should contact their designated contact person at OAT.

CSV Templates

Example CSV files, which illustrate the required columns for each data type, are available in the Portal.

All CSV files referenced in the Rostering API process must be downloaded and populated with the relevant details for the upload.