Retrieving RosterPush Files Via the API

This Knowledge Base article will give step by step instructions to retrieve Roster Push files via the API.

This can be done via a web browser or using a third party software like Postman to pull the information. Users will need to be logged-in to the web application before running the API call via a web browser. If using a third party software like Postman, users will need to acquire the proper credentials from their internal ARCOS Team.

Run two queries for the “Roster” endpoint.

1. 

https://prod.rostermonster.com/arcos/rest/rosters

The above will return a list of the available Roster Push Files, as shown below.

2. 

Using the above list, create your request. Your URL should be formatted as:

https://prod.rostermonster.com/arcos/rest/rosters[Name of file]

For example, if the file is named "rosterPush_20230112_074359_ET.zip" the resulting URL would read:

https://prod.rostermonster.com/arcos/rest/rosters/rosterPush_20230112_074359_ET.zip

The above will download the requested file. (having added the zip file name returned on the first query)