Authenticate
API | Description | |
---|---|---|
POST api/Authenticate/GetAuthenticationToken |
Retrieve an Authentication Token which is required with every API call. |
|
POST api/v1/orgs/Authenticate |
Retrieve an Authentication Token which is required with every API call. |
Candidate
JobBoards
Client
API | Description | |
---|---|---|
POST api/v1/orgs/{orgid}/Clients |
Create a new Client. if you do not know ATS client ID, Leave blank. |
|
GET api/v1/orgs/{orgid}/Clients?count={count}&skipcount={skipcount} |
Retrieve a list of Clients. |
|
GET api/v1/orgs/{orgid}/Clients/{clientid} |
Retrieve Client information. |
|
PUT api/v1/orgs/{orgid}/Clients/{Clientid} |
Update Client information and add new competitor companies and new industries( While adding new competitor companies and new industries need to send old competitor companies and industries json ), if you don't know ATS client ID leave blank. |
|
PUT api/v1/orgs/{orgid}/CompetitorCompanies/{CompetitorCompanyID} |
Update Competitor Company information for a Client. |
|
PUT api/v1/orgs/{orgid}/ClientIndustries/{ClientIndustryID} |
Update Industry information for a Client. |
Reporting
Users
API | Description | |
---|---|---|
GET api/v1/orgs/{orgid}/Users?count={count}&skipcount={skipcount} |
Retrieve a list of Users. |
|
GET api/v1/orgs/{orgid}/Users/{userid} |
Retrieve user details. |
|
POST api/v1/orgs/{orgid}/Users |
Create a new User in Arya( Only organization Admin have permissions to Create user information ). |
|
PUT api/v1/orgs/{orgid}/Users/{userid} |
Update user information( Only organization Admin have permissions to update user information ) |
|
POST api/v1/orgs/{orgid}/savediversitypercentagefororganization?diversitypercentage={diversitypercentage} |
To specify diversity percentage at org level (Only for Organization Admin) |
API | Description | |
---|---|---|
GET api/v1/orgs/{orgid}/EmailTemplates |
Retrieve a list of Email Templates list |
|
GET api/v1/orgs/{orgid}/emailtemplates/{emailtemplateid}/EmailTemplateDetails |
Retrieve of Email Template details |
|
GET api/v1/orgs/{orgid}/jobs/{jobid}/GetEmailConfiguration?aryaType={aryaType} |
Get Email config for job boards |
|
GET api/v1/orgs/{orgid}/jobs/{jobid}/aryasentemailsmetadata?take={take}&skip={skip}&ApplyViewed={ApplyViewed}&Viewed={Viewed}&aryaType={aryaType}&CandidateSearch={CandidateSearch} |
Arya Sent Emails Metadata |
|
POST api/v1/orgs/{orgid}/jobs/{jobid}/communicate?templateid={templateid}&candidateids={candidateids}&aryaType={aryaType} |
To Sending E-mails |
|
POST api/v1/orgs/{orgid}/jobs/{jobid}/communicatewithmailtext?aryaType={aryaType} |
Sending E-mails to candidate with customizage email text |
Internal
API | Description | |
---|---|---|
GET api/v1/orgs/{OrgId}/jobs/{JobId}/GetInternalSampleSearchParameters |
Retrieve the Internal saved search parameters for a Job |
|
POST api/v1/orgs/{OrgId}/jobs/{JobId}/InternalSampleSearch |
Internal Sample Search |
|
POST api/v1/orgs/{OrgId}/jobs/{JobId}/SaveInternalSampleSearchParameters |
Save Internal Sample Search Parameters |
JobAttachment
API | Description | |
---|---|---|
POST api/v1/JobAttachment |
Submit an Attachment for a Job. |
|
POST api/v1/MultipleJobAttachment |
Submit multiple Attachments for a Job. |
|
POST api/v1/orgs/{orgid}/RemoveAttachment |
To Remove the attachment file for a given job . |