Introduction
Using the API requires a username, password, and an API key. To obtain this information, an authorized customer contact must request one from their implementation specialist or account manager. API interaction is token based, so before calling any data access methods you must first call the AccessToken method to acquire a token verifying your credibility. The token must then be passed in an authorization header named “BDToken†in all subsequent requests. The Arcoro API supports JSON data structures in the body of requests and responses. All methods are versioned, which is controlled via the URI path in the request. For example, posting to https://api.birddoghr.com/v1/AccessToken would call version 1 of that method, whereas https://api.birddoghr.com/v2/AccessToken would call version 2.
EmployeeDocument
Get Employee Document methods will give customers access to retrieve specific employee documents.
| API | Description |
|---|---|
| GET current/GetEmployeeDocument |
Only one document for one employee can be retrieved in a single call. |
| GET v1/GetEmployeeDocument |
Only one document for one employee can be retrieved in a single call. |
| GET v2/GetEmployeeDocument |
Only one document for one employee can be retrieved in a single call. |
| GET current/GetUploadedDocumentsList |
Return a list of documents for a specific employee. |
| GET v1/GetUploadedDocumentsList |
Return a list of documents for a specific employee. |
| GET v2/GetUploadedDocumentsList |
Return a list of documents for a specific employee. |
| GET current/GetEmployeeAllDocuments |
Return a zip file containing all documents for a specific employee. |
| GET v1/GetEmployeeAllDocuments |
Return a zip file containing all documents for a specific employee. |
| GET v2/GetEmployeeAllDocuments |
Return a zip file containing all documents for a specific employee. |
TalentUsers
This controller manages user data in the LMS, Performance, and Succession Modules.
| API | Description |
|---|---|
| POST current/TalentUsers |
Existing users are identified by Username and, if found, they are updated with the request data. Otherwise a new user is created. If NULL is passed - field will be ignored. If an empty string is passed - field will be deleted. If an empty string is passed for a required field, the update of that record will fail and a message will be returned notifying the user what record(s) failed and why. If multiple records are passed and one fails, all records that can be successfully created/updated will be posted and a message will be returned notifying the user what record(s) failed and why. |
| POST v1/TalentUsers |
Existing users are identified by Username and, if found, they are updated with the request data. Otherwise a new user is created. If NULL is passed - field will be ignored. If an empty string is passed - field will be deleted. If an empty string is passed for a required field, the update of that record will fail and a message will be returned notifying the user what record(s) failed and why. If multiple records are passed and one fails, all records that can be successfully created/updated will be posted and a message will be returned notifying the user what record(s) failed and why. |
| POST v2/TalentUser |
Existing users are identified by Username and, if found, they are updated with the request data. Otherwise a new user is created. If NULL is passed - field will be ignored. If an empty string is passed - field will be deleted. If an empty string is passed for a required field, the update of that record will fail and a message will be returned notifying the user what record(s) failed and why. If multiple records are passed and one fails, all records that can be successfully created/updated will be posted and a message will be returned notifying the user what record(s) failed and why. |
| POST v2/TalentUsers |
Existing users are identified by Username and, if found, they are updated with the request data. |
| GET v2/TalentUsers |
Exsiting Talent users are returned. |
| GET v2/TalentUser?userName={userName} |
Exsiting Talent user with username is returned. |
| GET v2/EmployeeCertification?username[0]={username[0]}&username[1]={username[1]} |
Retrieves Employee Certifications in the LMS module for provided username(s). |
| GET v2/EmployeeLearningTranscript?username[0]={username[0]}&username[1]={username[1]} |
Retrieves Employee Learning Transcripts in the LMS module for provided username(s). |
AccessToken
This controller provides authentication and authorization for the Arcoro API.
| API | Description |
|---|---|
| POST current/accesstoken |
Successful authentication yields a token that must then be passed to all subsequent API calls for the specified version. This token is one-time use and expires after 5 minutes of inactivity. To obtain this the ApiKey, UserName, and Password, an authorized customer contact must request one from their implementation specialist or account manager. |
| POST v1/accesstoken |
Successful authentication yields a token that must then be passed to all subsequent API calls for the specified version. This token is one-time use and expires after 5 minutes of inactivity. To obtain this the ApiKey, UserName, and Password, an authorized customer contact must request one from their implementation specialist or account manager. |
| POST v2/accesstoken |
Successful authentication yields a token that must then be passed to all subsequent API calls for the specified version. This token is one-time use and expires after 5 minutes of inactivity. To obtain this the ApiKey, UserName, and Password, an authorized customer contact must request one from their implementation specialist or account manager. |
| POST v3/accesstoken |
Successful authentication yields a token that must then be passed to all subsequent API calls for the specified version. This token is one-time use and expires after 5 minutes of inactivity. To obtain this the ApiKey, UserName, and Password, an authorized customer contact must request one from their implementation specialist or account manager. |
JobCandidates
This controller manages applicant data in the ATS module. On an HTTP Get, query string parameters can be used to filter the data before retrieval. This creates a wide variety of use cases, from listing “Unprocessed” candidates on a dashboard to moving “Hired” applicants to another platform, usually a payroll or HRIS software program.
| API | Description |
|---|---|
| GET v1/JobCandidates |
Returns all candidates. |
| GET v2/JobCandidates |
Returns all candidates. |
| GET current/JobCandidates |
Returns all candidates. |
| GET v3/JobCandidates |
Returns all candidates. |
Employees
this controller gives customers access to Employee Information.
| API | Description |
|---|---|
| GET v1/Employees |
Employees method will give customers access to retrieve the data for their employees. |
| GET v2/Employees |
Employees method will give customers access to retrieve the data for their employees. |
| GET v3/Employees |
Employees method will give customers access to retrieve the data for their employees. |
| GET current/Employees |
Employees method will give customers access to retrieve the data for their employees. |
| GET v4/Employees |
Employees method will give customers access to retrieve the data for their employees. |
Jobs
This controller manages job data in the ATS module. On an HTTP Get, query string parameters can be used to filter the data before retrieval. This creates a wide variety of use cases.
| API | Description |
|---|---|
| GET current/Jobs |
Returns all jobs. |
| GET v1/Jobs |
Returns all jobs. |
