{"_id":"569e609bebbadc0d0079bed3","isReference":false,"parentDoc":null,"hidden":false,"link_external":false,"link_url":"","slug":"getting-started","type":"basic","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":"","auth":"required"},"createdAt":"2016-01-19T16:13:15.595Z","project":"569e6099ebbadc0d0079becd","title":"Getting Started with RolePoint Connect","updates":[],"user":"569e6058ffccd10d00a05b49","body":"## Connect Overview\n\nIntegrate once and connect directly to the leading Applicant Tracking Systems (ATSs). \n\nGet [jobs straight from the ATS](doc:job-webhooks) and [create your own application process](doc:get-jobs-and-insert-applications). [Search for candidates](doc:find-candidates) and build your own CRM or simply [get your candidates into the ATS with the correct source](doc:send-candidate).\n\nThe root URL for the API is https://api.rolepoint-connect.com/v1\nAll data is sent and received as JSON over HTTPS, using the Unicode UTF-8 text encoding.\nWe won’t rename or remove fields without a version bump.\n\n[Skip the overview and create your first Sandbox Connector](doc:sandbox-connector)","excerpt":"Get to know the features of Connect","category":"569e609aebbadc0d0079bed1","githubsync":"","order":0,"sync_unique":"","version":"569e609aebbadc0d0079bed0","__v":67,"childrenPages":[]}

Getting Started with RolePoint Connect

Get to know the features of Connect

## Connect Overview Integrate once and connect directly to the leading Applicant Tracking Systems (ATSs). Get [jobs straight from the ATS](doc:job-webhooks) and [create your own application process](doc:get-jobs-and-insert-applications). [Search for candidates](doc:find-candidates) and build your own CRM or simply [get your candidates into the ATS with the correct source](doc:send-candidate). The root URL for the API is https://api.rolepoint-connect.com/v1 All data is sent and received as JSON over HTTPS, using the Unicode UTF-8 text encoding. We won’t rename or remove fields without a version bump. [Skip the overview and create your first Sandbox Connector](doc:sandbox-connector)
## Connect Overview Integrate once and connect directly to the leading Applicant Tracking Systems (ATSs). Get [jobs straight from the ATS](doc:job-webhooks) and [create your own application process](doc:get-jobs-and-insert-applications). [Search for candidates](doc:find-candidates) and build your own CRM or simply [get your candidates into the ATS with the correct source](doc:send-candidate). The root URL for the API is https://api.rolepoint-connect.com/v1 All data is sent and received as JSON over HTTPS, using the Unicode UTF-8 text encoding. We won’t rename or remove fields without a version bump. [Skip the overview and create your first Sandbox Connector](doc:sandbox-connector)
{"_id":"56e4a86fca77c62900ee4154","createdAt":"2016-03-12T23:38:23.836Z","hidden":false,"order":1,"slug":"features","title":"Features","version":"569e609aebbadc0d0079bed0","__v":2,"link_url":"","parentDoc":null,"project":"569e6099ebbadc0d0079becd","isReference":false,"body":"### Apply\nCreate candidates and applications in the ATS.\n\n### Candidate Status\nGet updates on a candidate as they move through the application process.\n\n### Jobs\nGet notified when a job is created, updated or deleted.\n\n### Candidate Search\nSearch for candidates by email, creation date or modified date.\n\n### Candidate Detail\nGet details on a candidate like the application source or their phone number.","githubsync":"","link_external":false,"sync_unique":"","user":"56d846d5b20d260b0026570b","category":"569e609aebbadc0d0079bed1","excerpt":"","type":"basic","updates":[],"api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"childrenPages":[]}

Features


### Apply Create candidates and applications in the ATS. ### Candidate Status Get updates on a candidate as they move through the application process. ### Jobs Get notified when a job is created, updated or deleted. ### Candidate Search Search for candidates by email, creation date or modified date. ### Candidate Detail Get details on a candidate like the application source or their phone number.
### Apply Create candidates and applications in the ATS. ### Candidate Status Get updates on a candidate as they move through the application process. ### Jobs Get notified when a job is created, updated or deleted. ### Candidate Search Search for candidates by email, creation date or modified date. ### Candidate Detail Get details on a candidate like the application source or their phone number.
{"_id":"56e4a8d3c50aef1700971a62","api":{"auth":"required","params":[],"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":""},"body":"We're working on supporting all the features above with each ATS. The table below shows support for the main APIs in our standard ATSs. Things are moving quickly, so let us know if you need support for a feature or ATS not listed.\n[block:html]\n{\n  \"html\": \"<style type=\\\"text/css\\\">\\n\\n</style>\\n\\n<table style=\\\"background:white;\\\">\\n  <tr>\\n    <td> </td>\\n    <td align=\\\"center\\\"><img width=\\\"70px\\\" src=\\\"https://app.rolepoint-apply.com/public/admin/images/ats-tee.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"70px\\\" src=\\\"https://app.rolepoint-apply.com/public/admin/images/ats-tbe.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"70px\\\" src=\\\"https://app.rolepoint-apply.com/public/admin/images/ats-icims.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"70px\\\" src=\\\"https://app.rolepoint-apply.com/public/admin/images/ats-greenhouse.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"70px\\\" src=\\\"https://app.rolepoint-apply.com/public/admin/images/ats-lumesse.png\\\"></td>\\n  </tr>\\n  <tr>\\n    <td align=\\\"right\\\" class=\\\"title\\\"><b>Apply</b><br><small></small></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n  </tr>\\n  <tr>\\n    <td align=\\\"right\\\" class=\\\"title\\\"><b>Status</b><br><small></small></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n  </tr>\\n  <tr>\\n    <td align=\\\"right\\\" class=\\\"title\\\"><b>Jobs</b><br><small></small></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n  </tr>\\n\\n</table>\\n\\n\\n<style type=\\\"text/css\\\">\\n\\n</style>\\n\\n<table style=\\\"background:white;\\\">\\n  <tr>\\n    <td> </td>\\n    <td align=\\\"center\\\"><img width=\\\"70px\\\" src=\\\"https://app.rolepoint-apply.com/public/admin/images/ats-smart.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"70px\\\" src=\\\"https://app.rolepoint-apply.com/public/admin/images/ats-bullhorn.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"70px\\\" src=\\\"https://i.imgur.com/SY0GZFC.png\\\"></td>\\n    <td align=\\\"center\\\"><img style=\\\"margin-top:20px;\\\" width=\\\"70px\\\" src=\\\"https://i.imgur.com/YFut5bh.jpg\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"70px\\\" src=\\\"https://i.imgur.com/CZLFDit.jpg\\\"></td>\\n  </tr>\\n  <tr>\\n    <td align=\\\"right\\\" class=\\\"title\\\"><b>Apply</b><br><small></small></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n  </tr>\\n  <tr>\\n    <td align=\\\"right\\\" class=\\\"title\\\"><b>Status</b><br><small></small></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n  </tr>\\n  <tr>\\n    <td align=\\\"right\\\" class=\\\"title\\\"><b>Jobs</b><br><small></small></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n    <td align=\\\"center\\\"><img width=\\\"25\\\" style=\\\"margin-top:8px;\\\" src=\\\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\\\"></td>\\n  </tr>\\n\\n</table>\"\n}\n[/block]","parentDoc":null,"version":"569e609aebbadc0d0079bed0","createdAt":"2016-03-12T23:40:03.476Z","next":{"pages":[],"description":""},"project":"569e6099ebbadc0d0079becd","updates":[],"user":"56d846d5b20d260b0026570b","__v":7,"category":"569e609aebbadc0d0079bed1","isReference":false,"slug":"ats-api-support","sync_unique":"","type":"basic","title":"ATS API Support","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"childrenPages":[]}

ATS API Support


We're working on supporting all the features above with each ATS. The table below shows support for the main APIs in our standard ATSs. Things are moving quickly, so let us know if you need support for a feature or ATS not listed. [block:html] { "html": "<style type=\"text/css\">\n\n</style>\n\n<table style=\"background:white;\">\n <tr>\n <td> </td>\n <td align=\"center\"><img width=\"70px\" src=\"https://app.rolepoint-apply.com/public/admin/images/ats-tee.png\"></td>\n <td align=\"center\"><img width=\"70px\" src=\"https://app.rolepoint-apply.com/public/admin/images/ats-tbe.png\"></td>\n <td align=\"center\"><img width=\"70px\" src=\"https://app.rolepoint-apply.com/public/admin/images/ats-icims.png\"></td>\n <td align=\"center\"><img width=\"70px\" src=\"https://app.rolepoint-apply.com/public/admin/images/ats-greenhouse.png\"></td>\n <td align=\"center\"><img width=\"70px\" src=\"https://app.rolepoint-apply.com/public/admin/images/ats-lumesse.png\"></td>\n </tr>\n <tr>\n <td align=\"right\" class=\"title\"><b>Apply</b><br><small></small></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n </tr>\n <tr>\n <td align=\"right\" class=\"title\"><b>Status</b><br><small></small></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n </tr>\n <tr>\n <td align=\"right\" class=\"title\"><b>Jobs</b><br><small></small></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n </tr>\n\n</table>\n\n\n<style type=\"text/css\">\n\n</style>\n\n<table style=\"background:white;\">\n <tr>\n <td> </td>\n <td align=\"center\"><img width=\"70px\" src=\"https://app.rolepoint-apply.com/public/admin/images/ats-smart.png\"></td>\n <td align=\"center\"><img width=\"70px\" src=\"https://app.rolepoint-apply.com/public/admin/images/ats-bullhorn.png\"></td>\n <td align=\"center\"><img width=\"70px\" src=\"https://i.imgur.com/SY0GZFC.png\"></td>\n <td align=\"center\"><img style=\"margin-top:20px;\" width=\"70px\" src=\"https://i.imgur.com/YFut5bh.jpg\"></td>\n <td align=\"center\"><img width=\"70px\" src=\"https://i.imgur.com/CZLFDit.jpg\"></td>\n </tr>\n <tr>\n <td align=\"right\" class=\"title\"><b>Apply</b><br><small></small></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n </tr>\n <tr>\n <td align=\"right\" class=\"title\"><b>Status</b><br><small></small></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n </tr>\n <tr>\n <td align=\"right\" class=\"title\"><b>Jobs</b><br><small></small></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n </tr>\n\n</table>" } [/block]
We're working on supporting all the features above with each ATS. The table below shows support for the main APIs in our standard ATSs. Things are moving quickly, so let us know if you need support for a feature or ATS not listed. [block:html] { "html": "<style type=\"text/css\">\n\n</style>\n\n<table style=\"background:white;\">\n <tr>\n <td> </td>\n <td align=\"center\"><img width=\"70px\" src=\"https://app.rolepoint-apply.com/public/admin/images/ats-tee.png\"></td>\n <td align=\"center\"><img width=\"70px\" src=\"https://app.rolepoint-apply.com/public/admin/images/ats-tbe.png\"></td>\n <td align=\"center\"><img width=\"70px\" src=\"https://app.rolepoint-apply.com/public/admin/images/ats-icims.png\"></td>\n <td align=\"center\"><img width=\"70px\" src=\"https://app.rolepoint-apply.com/public/admin/images/ats-greenhouse.png\"></td>\n <td align=\"center\"><img width=\"70px\" src=\"https://app.rolepoint-apply.com/public/admin/images/ats-lumesse.png\"></td>\n </tr>\n <tr>\n <td align=\"right\" class=\"title\"><b>Apply</b><br><small></small></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n </tr>\n <tr>\n <td align=\"right\" class=\"title\"><b>Status</b><br><small></small></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n </tr>\n <tr>\n <td align=\"right\" class=\"title\"><b>Jobs</b><br><small></small></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n </tr>\n\n</table>\n\n\n<style type=\"text/css\">\n\n</style>\n\n<table style=\"background:white;\">\n <tr>\n <td> </td>\n <td align=\"center\"><img width=\"70px\" src=\"https://app.rolepoint-apply.com/public/admin/images/ats-smart.png\"></td>\n <td align=\"center\"><img width=\"70px\" src=\"https://app.rolepoint-apply.com/public/admin/images/ats-bullhorn.png\"></td>\n <td align=\"center\"><img width=\"70px\" src=\"https://i.imgur.com/SY0GZFC.png\"></td>\n <td align=\"center\"><img style=\"margin-top:20px;\" width=\"70px\" src=\"https://i.imgur.com/YFut5bh.jpg\"></td>\n <td align=\"center\"><img width=\"70px\" src=\"https://i.imgur.com/CZLFDit.jpg\"></td>\n </tr>\n <tr>\n <td align=\"right\" class=\"title\"><b>Apply</b><br><small></small></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n </tr>\n <tr>\n <td align=\"right\" class=\"title\"><b>Status</b><br><small></small></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n </tr>\n <tr>\n <td align=\"right\" class=\"title\"><b>Jobs</b><br><small></small></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n <td align=\"center\"><img width=\"25\" style=\"margin-top:8px;\" src=\"https://cdn0.iconfinder.com/data/icons/round-ui-icons/128/tick_green.png\"></td>\n </tr>\n\n</table>" } [/block]
{"_id":"56ddc5890cfa331700f4d002","isReference":false,"link_url":"","slug":"authentication","sync_unique":"","category":"56d730d436dd840b00cef0f7","hidden":false,"parentDoc":null,"type":"basic","user":"543d38fea10ab32000b3aa8f","version":"569e609aebbadc0d0079bed0","api":{"auth":"required","params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"excerpt":"","githubsync":"","title":"Authentication","updates":[],"__v":4,"createdAt":"2016-03-07T18:16:41.304Z","order":0,"project":"569e6099ebbadc0d0079becd","body":"You should issue all requests with Basic Authentication parameters using the credentials you were provided with.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -u username:password https://api.rolepoint-connect.com\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nRequests that require authentication may return a `404 Not Found` instead of a `401 Authorization Required` or `403 Forbidden` response to avoid leaking private URLs.\n\n### Failed login limit\n\nAuthenticating with invalid credentials will return `401 Unauthorized`.  After detecting several requests with invalid credentials within a short period, the API will temporarily reject all authentication attempts for that user (including ones with valid credentials) with a `403 Forbidden` response.","link_external":false,"childrenPages":[]}

Authentication


You should issue all requests with Basic Authentication parameters using the credentials you were provided with. [block:code] { "codes": [ { "code": "curl -u username:password https://api.rolepoint-connect.com", "language": "curl" } ] } [/block] Requests that require authentication may return a `404 Not Found` instead of a `401 Authorization Required` or `403 Forbidden` response to avoid leaking private URLs. ### Failed login limit Authenticating with invalid credentials will return `401 Unauthorized`. After detecting several requests with invalid credentials within a short period, the API will temporarily reject all authentication attempts for that user (including ones with valid credentials) with a `403 Forbidden` response.
You should issue all requests with Basic Authentication parameters using the credentials you were provided with. [block:code] { "codes": [ { "code": "curl -u username:password https://api.rolepoint-connect.com", "language": "curl" } ] } [/block] Requests that require authentication may return a `404 Not Found` instead of a `401 Authorization Required` or `403 Forbidden` response to avoid leaking private URLs. ### Failed login limit Authenticating with invalid credentials will return `401 Unauthorized`. After detecting several requests with invalid credentials within a short period, the API will temporarily reject all authentication attempts for that user (including ones with valid credentials) with a `403 Forbidden` response.
{"_id":"56ddbcda5771a520003923b0","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"","auth":"required","params":[]},"project":"569e6099ebbadc0d0079becd","slug":"version","type":"basic","updates":[],"githubsync":"","isReference":false,"user":"543d38fea10ab32000b3aa8f","body":"By default, all requests currently use v2 of the API.  We encourage you to explicitly request this version via the `Accept` header.\n\n    Accept: application/rolepoint.v2+json\n    \nSee [Media Types](media-types/) for more information.","createdAt":"2016-03-07T17:39:38.008Z","excerpt":"","link_url":"","parentDoc":null,"sync_unique":"","title":"Version","__v":2,"category":"56d730d436dd840b00cef0f7","hidden":false,"link_external":false,"order":1,"version":"569e609aebbadc0d0079bed0","childrenPages":[]}

Version


By default, all requests currently use v2 of the API. We encourage you to explicitly request this version via the `Accept` header. Accept: application/rolepoint.v2+json See [Media Types](media-types/) for more information.
By default, all requests currently use v2 of the API. We encourage you to explicitly request this version via the `Accept` header. Accept: application/rolepoint.v2+json See [Media Types](media-types/) for more information.
{"_id":"56ddbd530e801d2900c2e408","createdAt":"2016-03-07T17:41:39.516Z","hidden":false,"sync_unique":"","title":"Schema","version":"569e609aebbadc0d0079bed0","__v":4,"isReference":false,"parentDoc":null,"project":"569e6099ebbadc0d0079becd","type":"basic","user":"543d38fea10ab32000b3aa8f","api":{"params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"","auth":"required"},"category":"56d730d436dd840b00cef0f7","link_external":false,"updates":[],"githubsync":"","link_url":"","order":2,"slug":"schema","body":"All API access is over HTTPS and accessed from the `api.rolepoint-connect.com` domain. All data is sent and received as JSON.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"    curl --user user:pass https://api.rolepoint-connect.com/endpoint\\n\\n    > {'connected': True}\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nOptional fields can be sent in as `null` or omitted.  Optional fields in responses will not be omitted - instead they will be returned as `null` or empty.\n\nAll timestamps are returned in ISO 8601 format:\n\n    YYYY-MM-DDTHH:MM:SSZ","excerpt":"","childrenPages":[]}

Schema


All API access is over HTTPS and accessed from the `api.rolepoint-connect.com` domain. All data is sent and received as JSON. [block:code] { "codes": [ { "code": " curl --user user:pass https://api.rolepoint-connect.com/endpoint\n\n > {'connected': True}", "language": "curl" } ] } [/block] Optional fields can be sent in as `null` or omitted. Optional fields in responses will not be omitted - instead they will be returned as `null` or empty. All timestamps are returned in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
All API access is over HTTPS and accessed from the `api.rolepoint-connect.com` domain. All data is sent and received as JSON. [block:code] { "codes": [ { "code": " curl --user user:pass https://api.rolepoint-connect.com/endpoint\n\n > {'connected': True}", "language": "curl" } ] } [/block] Optional fields can be sent in as `null` or omitted. Optional fields in responses will not be omitted - instead they will be returned as `null` or empty. All timestamps are returned in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
{"_id":"56ddbd80d55588290014a918","api":{"params":[],"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":"","auth":"required"},"isReference":false,"link_external":false,"order":3,"slug":"success-responses","type":"basic","body":"Successful API calls will return a `200 OK` response.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/1.1 200 OK\\n\\n{}\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]","githubsync":"","hidden":false,"link_url":"","project":"569e6099ebbadc0d0079becd","user":"543d38fea10ab32000b3aa8f","version":"569e609aebbadc0d0079bed0","__v":3,"category":"56d730d436dd840b00cef0f7","excerpt":"","parentDoc":null,"createdAt":"2016-03-07T17:42:24.611Z","sync_unique":"","title":"Success Responses","updates":[],"childrenPages":[]}

Success Responses


Successful API calls will return a `200 OK` response. [block:code] { "codes": [ { "code": "HTTP/1.1 200 OK\n\n{}", "language": "http" } ] } [/block]
Successful API calls will return a `200 OK` response. [block:code] { "codes": [ { "code": "HTTP/1.1 200 OK\n\n{}", "language": "http" } ] } [/block]
{"_id":"56ddbb9350dd421700424b7e","sync_unique":"","title":"Asynchronous Requests","api":{"params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"","auth":"required"},"hidden":false,"order":4,"project":"569e6099ebbadc0d0079becd","category":"56d730d436dd840b00cef0f7","isReference":false,"updates":[],"slug":"asynchronous-requests","version":"569e609aebbadc0d0079bed0","createdAt":"2016-03-07T17:34:11.319Z","excerpt":"","githubsync":"","link_external":false,"parentDoc":null,"__v":15,"body":"The API has some endpoints that process requests asynchronously. Each request to Connect can map to one or more requests to the ATS, which could potentially take a long time to process due to request times to the ATS or rate limiting requirements. Working asynchronously will help hide this from your users and allow Connect to stay within the limits imposed by the ATS.\n\n### Callbacks\n\nEach asynchronous endpoint will accept a `X-RolePoint-Callback-Url` HTTP header that we will post a JSON status report to upon completion of the task. The data POSTed to the callback url will follow the [completed](#section-completed) or [failed](#section-failed) status reports below.\n\n### Completed\n\nIf the task has completed, the status report will be of the format:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"status\\\": \\\"complete\\\",\\n  \\\"result_info\\\": {\\n    \\\"url\\\": \\\"https://api.rolepoint-connect.com/:endpoint/:request_id/result\\\",\\n    \\\"ttl\\\": 123\\n  },\\n  \\\"error_info\\\": null\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nWhere the `url` can be used to get the result of the task (e.g. the results of a [Find Candidates](doc:find-candidates) query) and the `ttl` refers to the time until the result expires.\n\n### Failed\n\nIf the task failed, the response will have the form:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"status\\\": \\\"failed\\\",\\n  \\\"result_info\\\": {\\n    \\\"url\\\": \\\"https://api.rolepoint-connect.com/:endpoint/:request_id/result\\\",\\n    \\\"ttl\\\": 123\\n  },\\n  \\\"error_info\\\": {\\n    \\\"message\\\": \\\"Message describing the error that occured\\\",\\n    \\\"code\\\": 123\\n  }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nWhere the `code` is one of the defined [Error Codes](doc:error-codes) and the `message` describes why the task failed.\n\n### Polling request status\n\nAsynchronous endpoints will also return a status URL that you can poll for status updates and success reports. This is useful when working in an environment where accepting a callback POST is not possible.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"We recommend using the callback functionality rather than polling Connect. Each request to Connect can map to one or more requests to the ATS, which could potentially take a while to process. By sending a callback we reduce the need to make several needless connections over what could be an extended period of time.\",\n  \"title\": \"Polling not recommended\"\n}\n[/block]\n[Async Request Status](doc:get-async-request-status) can be used to check the status of an synchronous task.\n\nThe [completed](#section-completed) and [failed](#section-failed) status reports are the same as for callbacks above.","link_url":"","type":"basic","user":"543d38fea10ab32000b3aa8f","childrenPages":[]}

Asynchronous Requests


The API has some endpoints that process requests asynchronously. Each request to Connect can map to one or more requests to the ATS, which could potentially take a long time to process due to request times to the ATS or rate limiting requirements. Working asynchronously will help hide this from your users and allow Connect to stay within the limits imposed by the ATS. ### Callbacks Each asynchronous endpoint will accept a `X-RolePoint-Callback-Url` HTTP header that we will post a JSON status report to upon completion of the task. The data POSTed to the callback url will follow the [completed](#section-completed) or [failed](#section-failed) status reports below. ### Completed If the task has completed, the status report will be of the format: [block:code] { "codes": [ { "code": "{\n \"status\": \"complete\",\n \"result_info\": {\n \"url\": \"https://api.rolepoint-connect.com/:endpoint/:request_id/result\",\n \"ttl\": 123\n },\n \"error_info\": null\n}", "language": "json" } ] } [/block] Where the `url` can be used to get the result of the task (e.g. the results of a [Find Candidates](doc:find-candidates) query) and the `ttl` refers to the time until the result expires. ### Failed If the task failed, the response will have the form: [block:code] { "codes": [ { "code": "{\n \"status\": \"failed\",\n \"result_info\": {\n \"url\": \"https://api.rolepoint-connect.com/:endpoint/:request_id/result\",\n \"ttl\": 123\n },\n \"error_info\": {\n \"message\": \"Message describing the error that occured\",\n \"code\": 123\n }\n}", "language": "json" } ] } [/block] Where the `code` is one of the defined [Error Codes](doc:error-codes) and the `message` describes why the task failed. ### Polling request status Asynchronous endpoints will also return a status URL that you can poll for status updates and success reports. This is useful when working in an environment where accepting a callback POST is not possible. [block:callout] { "type": "warning", "body": "We recommend using the callback functionality rather than polling Connect. Each request to Connect can map to one or more requests to the ATS, which could potentially take a while to process. By sending a callback we reduce the need to make several needless connections over what could be an extended period of time.", "title": "Polling not recommended" } [/block] [Async Request Status](doc:get-async-request-status) can be used to check the status of an synchronous task. The [completed](#section-completed) and [failed](#section-failed) status reports are the same as for callbacks above.
The API has some endpoints that process requests asynchronously. Each request to Connect can map to one or more requests to the ATS, which could potentially take a long time to process due to request times to the ATS or rate limiting requirements. Working asynchronously will help hide this from your users and allow Connect to stay within the limits imposed by the ATS. ### Callbacks Each asynchronous endpoint will accept a `X-RolePoint-Callback-Url` HTTP header that we will post a JSON status report to upon completion of the task. The data POSTed to the callback url will follow the [completed](#section-completed) or [failed](#section-failed) status reports below. ### Completed If the task has completed, the status report will be of the format: [block:code] { "codes": [ { "code": "{\n \"status\": \"complete\",\n \"result_info\": {\n \"url\": \"https://api.rolepoint-connect.com/:endpoint/:request_id/result\",\n \"ttl\": 123\n },\n \"error_info\": null\n}", "language": "json" } ] } [/block] Where the `url` can be used to get the result of the task (e.g. the results of a [Find Candidates](doc:find-candidates) query) and the `ttl` refers to the time until the result expires. ### Failed If the task failed, the response will have the form: [block:code] { "codes": [ { "code": "{\n \"status\": \"failed\",\n \"result_info\": {\n \"url\": \"https://api.rolepoint-connect.com/:endpoint/:request_id/result\",\n \"ttl\": 123\n },\n \"error_info\": {\n \"message\": \"Message describing the error that occured\",\n \"code\": 123\n }\n}", "language": "json" } ] } [/block] Where the `code` is one of the defined [Error Codes](doc:error-codes) and the `message` describes why the task failed. ### Polling request status Asynchronous endpoints will also return a status URL that you can poll for status updates and success reports. This is useful when working in an environment where accepting a callback POST is not possible. [block:callout] { "type": "warning", "body": "We recommend using the callback functionality rather than polling Connect. Each request to Connect can map to one or more requests to the ATS, which could potentially take a while to process. By sending a callback we reduce the need to make several needless connections over what could be an extended period of time.", "title": "Polling not recommended" } [/block] [Async Request Status](doc:get-async-request-status) can be used to check the status of an synchronous task. The [completed](#section-completed) and [failed](#section-failed) status reports are the same as for callbacks above.
{"_id":"56ddbd9ae1a78d0e00a9bdd7","createdAt":"2016-03-07T17:42:50.345Z","project":"569e6099ebbadc0d0079becd","updates":[],"user":"543d38fea10ab32000b3aa8f","title":"Errors","version":"569e609aebbadc0d0079bed0","category":"56d730d436dd840b00cef0f7","githubsync":"","isReference":false,"slug":"client-responses","hidden":false,"parentDoc":null,"link_url":"","order":5,"sync_unique":"","__v":9,"api":{"url":"","auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":""},"body":"## Client Errors\n\nThere are six types of client errors on API calls:\n\n1. Sending a request with missing credentials will result in a `401\n   Unauthorized` response\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/1.1 401 Unauthorized\\n\\n{\\\"message\\\": \\\"Missing credentials\\\"}\\n\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n2. Sending a request with invalid or insufficient credentials will result in a\n   `401 Unauthorized` response.\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/1.1 401 Unauthorized\\n\\n{\\\"message\\\": \\\"Invalid credentials\\\"}\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n3. Sending a request to an endpoint that does not exist will result in a `404\n   Not Found` response.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/1.1 404 Not Found\\n\\n{\\\"message\\\": \\\"Page not found\\\"}\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n4. Sending malformed JSON bodies will result in a `400 Bad Request` response.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/1.1 400 Bad Request\\n\\n{\\\"message\\\": \\\"Problems parsing JSON\\\"}\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n5. Sending JSON bodies with missing fields or unexpected fields will result in a `422\n   Unprocessable Entity` response.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/1.1 422 Unprocessable Entity\\n\\n{\\\"message\\\": \\\"JSON does not match expected schema.\\\"}\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n6. Sending a request that exceeds rate limits will result in a `429 Too Many\n   Requests` response.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/1.1 429 Too Many Requests\\n\\n{\\\"message\\\": \\\"Rate limit exceeded\\\", \\\"rate-limit-reset\\\": \\\"60\\\"}\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\nThe `rate-limit-reset` field in this response is the number of seconds until\nthe rate limit will be reset.\n\nIf endpoints have custom validation errors, they will be documented with the\nendpoint.\n\n## Other Errors\n\nIf an unexpected error occurs during an API call, the server will return a `500\nInternal Server Error`\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/1.1 500 Internal Server Error\\n\\n{\\\"message\\\": \\\"Unknown error\\\"}\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\nYou should assume that these requests failed and attempt them again later.","excerpt":"","link_external":false,"type":"basic","childrenPages":[]}

Errors


## Client Errors There are six types of client errors on API calls: 1. Sending a request with missing credentials will result in a `401 Unauthorized` response [block:code] { "codes": [ { "code": "HTTP/1.1 401 Unauthorized\n\n{\"message\": \"Missing credentials\"}\n", "language": "http" } ] } [/block] 2. Sending a request with invalid or insufficient credentials will result in a `401 Unauthorized` response. [block:code] { "codes": [ { "code": "HTTP/1.1 401 Unauthorized\n\n{\"message\": \"Invalid credentials\"}", "language": "http" } ] } [/block] 3. Sending a request to an endpoint that does not exist will result in a `404 Not Found` response. [block:code] { "codes": [ { "code": "HTTP/1.1 404 Not Found\n\n{\"message\": \"Page not found\"}", "language": "http" } ] } [/block] 4. Sending malformed JSON bodies will result in a `400 Bad Request` response. [block:code] { "codes": [ { "code": "HTTP/1.1 400 Bad Request\n\n{\"message\": \"Problems parsing JSON\"}", "language": "http" } ] } [/block] 5. Sending JSON bodies with missing fields or unexpected fields will result in a `422 Unprocessable Entity` response. [block:code] { "codes": [ { "code": "HTTP/1.1 422 Unprocessable Entity\n\n{\"message\": \"JSON does not match expected schema.\"}", "language": "http" } ] } [/block] 6. Sending a request that exceeds rate limits will result in a `429 Too Many Requests` response. [block:code] { "codes": [ { "code": "HTTP/1.1 429 Too Many Requests\n\n{\"message\": \"Rate limit exceeded\", \"rate-limit-reset\": \"60\"}", "language": "http" } ] } [/block] The `rate-limit-reset` field in this response is the number of seconds until the rate limit will be reset. If endpoints have custom validation errors, they will be documented with the endpoint. ## Other Errors If an unexpected error occurs during an API call, the server will return a `500 Internal Server Error` [block:code] { "codes": [ { "code": "HTTP/1.1 500 Internal Server Error\n\n{\"message\": \"Unknown error\"}", "language": "http" } ] } [/block] You should assume that these requests failed and attempt them again later.
## Client Errors There are six types of client errors on API calls: 1. Sending a request with missing credentials will result in a `401 Unauthorized` response [block:code] { "codes": [ { "code": "HTTP/1.1 401 Unauthorized\n\n{\"message\": \"Missing credentials\"}\n", "language": "http" } ] } [/block] 2. Sending a request with invalid or insufficient credentials will result in a `401 Unauthorized` response. [block:code] { "codes": [ { "code": "HTTP/1.1 401 Unauthorized\n\n{\"message\": \"Invalid credentials\"}", "language": "http" } ] } [/block] 3. Sending a request to an endpoint that does not exist will result in a `404 Not Found` response. [block:code] { "codes": [ { "code": "HTTP/1.1 404 Not Found\n\n{\"message\": \"Page not found\"}", "language": "http" } ] } [/block] 4. Sending malformed JSON bodies will result in a `400 Bad Request` response. [block:code] { "codes": [ { "code": "HTTP/1.1 400 Bad Request\n\n{\"message\": \"Problems parsing JSON\"}", "language": "http" } ] } [/block] 5. Sending JSON bodies with missing fields or unexpected fields will result in a `422 Unprocessable Entity` response. [block:code] { "codes": [ { "code": "HTTP/1.1 422 Unprocessable Entity\n\n{\"message\": \"JSON does not match expected schema.\"}", "language": "http" } ] } [/block] 6. Sending a request that exceeds rate limits will result in a `429 Too Many Requests` response. [block:code] { "codes": [ { "code": "HTTP/1.1 429 Too Many Requests\n\n{\"message\": \"Rate limit exceeded\", \"rate-limit-reset\": \"60\"}", "language": "http" } ] } [/block] The `rate-limit-reset` field in this response is the number of seconds until the rate limit will be reset. If endpoints have custom validation errors, they will be documented with the endpoint. ## Other Errors If an unexpected error occurs during an API call, the server will return a `500 Internal Server Error` [block:code] { "codes": [ { "code": "HTTP/1.1 500 Internal Server Error\n\n{\"message\": \"Unknown error\"}", "language": "http" } ] } [/block] You should assume that these requests failed and attempt them again later.
{"_id":"56ddc57225a3dd1700e5c758","hidden":false,"excerpt":"","link_external":false,"order":6,"slug":"error-codes","title":"Error Codes","isReference":false,"parentDoc":null,"project":"569e6099ebbadc0d0079becd","__v":3,"body":"### 100 - ATS Unauthorized Error\n\n100 is the error code Connect sends when there's an authorization problem connecting to the ATS. If there's a problem authorizing with the ATS, Connect will shut down any future attempts to connect to the ATS until we can confirm the credentials work. This is to prevent the ATS account being locked for multiple invalid authorization requests.\n\n### 999 - General Purpose Error\n\nThis is a general purpose error code. This will be returned as a 'catch-all', so if there is an unexpected error, this code would be returned with a message indicating what went wrong.","category":"56d730d436dd840b00cef0f7","createdAt":"2016-03-07T18:16:18.539Z","updates":[],"user":"543d38fea10ab32000b3aa8f","version":"569e609aebbadc0d0079bed0","api":{"params":[],"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required"},"githubsync":"","link_url":"","sync_unique":"","type":"basic","childrenPages":[]}

Error Codes


### 100 - ATS Unauthorized Error 100 is the error code Connect sends when there's an authorization problem connecting to the ATS. If there's a problem authorizing with the ATS, Connect will shut down any future attempts to connect to the ATS until we can confirm the credentials work. This is to prevent the ATS account being locked for multiple invalid authorization requests. ### 999 - General Purpose Error This is a general purpose error code. This will be returned as a 'catch-all', so if there is an unexpected error, this code would be returned with a message indicating what went wrong.
### 100 - ATS Unauthorized Error 100 is the error code Connect sends when there's an authorization problem connecting to the ATS. If there's a problem authorizing with the ATS, Connect will shut down any future attempts to connect to the ATS until we can confirm the credentials work. This is to prevent the ATS account being locked for multiple invalid authorization requests. ### 999 - General Purpose Error This is a general purpose error code. This will be returned as a 'catch-all', so if there is an unexpected error, this code would be returned with a message indicating what went wrong.
{"_id":"56e453c0f0150e1700ce67fc","category":"56d730d436dd840b00cef0f7","githubsync":"","isReference":false,"order":7,"parentDoc":null,"slug":"billing-limits","type":"basic","createdAt":"2016-03-12T17:37:04.922Z","hidden":false,"body":"The API has credit limits, defined on a per-connector basis.\n\nYou can check the returned HTTP headers of any API request to see your current credit limit status:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -i https://api.rolepoint-connect.com/whatever\\n\\nHTTP/1.1 200 OK\\nStatus: 200 OK\\nX-CreditLimit-Limit: 60\\nX-CreditLimit-Remaining: 56\\nX-CreditLimit_Reset: 1372700873\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nThe headers tell you everything you need to know about your current credit limit status:\n\n* X-CreditLimit-Limit - The maximum number of requests that the consumer is permitted to make per hour.\n* X-CreditLimit-Remaining - The number of requests remaining in the current credit window.\n* X-CreditLimit-Reset - The time at which the current credit window resets in UTC epoch seconds.\n\nOnce you go over your credit limit you will receive an error response:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/1.1 429 Too Many Requests\\nStatus: 429 Too Many Requests\\nX-CreditLimit-Limit: 60\\nX-CreditLimit-Remaining: 0\\nX-CreditLimit-Reset: 1372700873\\n\\n{\\\"message\\\": \\\"Rate limit exceeded\\\", \\\"rate-limit-reset\\\": 1372700873}\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]","excerpt":"","link_url":"","sync_unique":"","title":"Billing limits","version":"569e609aebbadc0d0079bed0","__v":4,"api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"link_external":false,"project":"569e6099ebbadc0d0079becd","updates":[],"user":"56d846d5b20d260b0026570b","childrenPages":[]}

Billing limits


The API has credit limits, defined on a per-connector basis. You can check the returned HTTP headers of any API request to see your current credit limit status: [block:code] { "codes": [ { "code": "curl -i https://api.rolepoint-connect.com/whatever\n\nHTTP/1.1 200 OK\nStatus: 200 OK\nX-CreditLimit-Limit: 60\nX-CreditLimit-Remaining: 56\nX-CreditLimit_Reset: 1372700873", "language": "curl" } ] } [/block] The headers tell you everything you need to know about your current credit limit status: * X-CreditLimit-Limit - The maximum number of requests that the consumer is permitted to make per hour. * X-CreditLimit-Remaining - The number of requests remaining in the current credit window. * X-CreditLimit-Reset - The time at which the current credit window resets in UTC epoch seconds. Once you go over your credit limit you will receive an error response: [block:code] { "codes": [ { "code": "HTTP/1.1 429 Too Many Requests\nStatus: 429 Too Many Requests\nX-CreditLimit-Limit: 60\nX-CreditLimit-Remaining: 0\nX-CreditLimit-Reset: 1372700873\n\n{\"message\": \"Rate limit exceeded\", \"rate-limit-reset\": 1372700873}", "language": "http" } ] } [/block]
The API has credit limits, defined on a per-connector basis. You can check the returned HTTP headers of any API request to see your current credit limit status: [block:code] { "codes": [ { "code": "curl -i https://api.rolepoint-connect.com/whatever\n\nHTTP/1.1 200 OK\nStatus: 200 OK\nX-CreditLimit-Limit: 60\nX-CreditLimit-Remaining: 56\nX-CreditLimit_Reset: 1372700873", "language": "curl" } ] } [/block] The headers tell you everything you need to know about your current credit limit status: * X-CreditLimit-Limit - The maximum number of requests that the consumer is permitted to make per hour. * X-CreditLimit-Remaining - The number of requests remaining in the current credit window. * X-CreditLimit-Reset - The time at which the current credit window resets in UTC epoch seconds. Once you go over your credit limit you will receive an error response: [block:code] { "codes": [ { "code": "HTTP/1.1 429 Too Many Requests\nStatus: 429 Too Many Requests\nX-CreditLimit-Limit: 60\nX-CreditLimit-Remaining: 0\nX-CreditLimit-Reset: 1372700873\n\n{\"message\": \"Rate limit exceeded\", \"rate-limit-reset\": 1372700873}", "language": "http" } ] } [/block]
{"_id":"56ddc61490559a2900a3a4ae","title":"Rate Limits","version":"569e609aebbadc0d0079bed0","category":"56d730d436dd840b00cef0f7","githubsync":"","link_external":false,"parentDoc":null,"type":"basic","updates":[],"excerpt":"","isReference":false,"project":"569e6099ebbadc0d0079becd","slug":"rate-limits","sync_unique":"","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"","auth":"required","params":[]},"createdAt":"2016-03-07T18:19:00.819Z","user":"543d38fea10ab32000b3aa8f","__v":4,"body":"The connector API has rate limits, which vary by ATS. These are separate from the billing-based credit limits described above. These are in place to ensure that we don't exceed the rate limits imposed by the underlying ATS.\n\nThese rate limits are implemented using a sliding window that should allow you to burst at a higher rate than the ATS usually allows, but will not allow you to maintain that level indefinitely.\n\nYou can check the returned HTTP headers of any API request to see your current rate limit status:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -i https://api.rolepoint-connect.com/whatever\\n\\nHTTP/1.1 200 OK\\nStatus: 200 OK\\nX-RateLimit-Remaining: 1\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nThese limiters are implemented as a sliding window, so do not provide reset information.\n\nOnce you go over your rate limit, you will receive an error response:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/1.1 429 Too Many Requests\\nStatus: 429 Too Many Requests\\nX-CreditLimit-Remaining: 0\\n\\n{\\\"message\\\": \\\"Rate limit exceeded\\\"}\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]","hidden":false,"link_url":"","order":8,"childrenPages":[]}

Rate Limits


The connector API has rate limits, which vary by ATS. These are separate from the billing-based credit limits described above. These are in place to ensure that we don't exceed the rate limits imposed by the underlying ATS. These rate limits are implemented using a sliding window that should allow you to burst at a higher rate than the ATS usually allows, but will not allow you to maintain that level indefinitely. You can check the returned HTTP headers of any API request to see your current rate limit status: [block:code] { "codes": [ { "code": "curl -i https://api.rolepoint-connect.com/whatever\n\nHTTP/1.1 200 OK\nStatus: 200 OK\nX-RateLimit-Remaining: 1", "language": "curl" } ] } [/block] These limiters are implemented as a sliding window, so do not provide reset information. Once you go over your rate limit, you will receive an error response: [block:code] { "codes": [ { "code": "HTTP/1.1 429 Too Many Requests\nStatus: 429 Too Many Requests\nX-CreditLimit-Remaining: 0\n\n{\"message\": \"Rate limit exceeded\"}", "language": "http" } ] } [/block]
The connector API has rate limits, which vary by ATS. These are separate from the billing-based credit limits described above. These are in place to ensure that we don't exceed the rate limits imposed by the underlying ATS. These rate limits are implemented using a sliding window that should allow you to burst at a higher rate than the ATS usually allows, but will not allow you to maintain that level indefinitely. You can check the returned HTTP headers of any API request to see your current rate limit status: [block:code] { "codes": [ { "code": "curl -i https://api.rolepoint-connect.com/whatever\n\nHTTP/1.1 200 OK\nStatus: 200 OK\nX-RateLimit-Remaining: 1", "language": "curl" } ] } [/block] These limiters are implemented as a sliding window, so do not provide reset information. Once you go over your rate limit, you will receive an error response: [block:code] { "codes": [ { "code": "HTTP/1.1 429 Too Many Requests\nStatus: 429 Too Many Requests\nX-CreditLimit-Remaining: 0\n\n{\"message\": \"Rate limit exceeded\"}", "language": "http" } ] } [/block]
{"_id":"56d732043eb4dd0b00201922","category":"56d8457a9d27560b00a4cc17","createdAt":"2016-03-02T18:33:40.339Z","hidden":false,"isReference":true,"project":"569e6099ebbadc0d0079becd","updates":[],"__v":4,"api":{"auth":"required","examples":{"codes":[]},"method":"post","params":[{"name":"connector_id","ref":"","required":false,"type":"string","in":"body","_id":"56d7330a3513421d009342ec","default":"","desc":"The ID of your Connector."}],"results":{"codes":[{"code":"{\n  \"request_status_url\": \"https://api.rolepoint-connect.com/123/requests/456/status\"\n}","language":"json","status":200},{"code":"{\n  \"message\": \"JSON does not match expected schema\",\n  \"errors\": [\n    \"empty values not allowed for field 'first_name'\",\n    \"empty values not allowed for field 'last_name'\"\n  ]\n}","language":"json","status":422},{"language":"json","code":"{\"message\": \"Rate limit exceeded\"}","status":429},{"code":"{\"message\": \"Invalid credentials\"}\nor\n{\"message\": \"Missing credentials\"}","language":"json","status":401}]},"settings":"","url":"/candidate"},"body":"[block:textarea]\n{\n  \"text\": \"## Request\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /v1/123/candidate HTTP/1.1\\nHost: api.rolepoint-connect.com\\nAccept: application/rolepoint.v2+json\\nContent-Type: application/rolepoint.v2+json\\nAuthorization: xxxxx\\nX-RolePoint-Callback-Url: https://example.com/send-candidate-callback\\n\\n{\\n  \\\"source\\\": \\\"example\\\",\\n  \\\"candidate\\\": {\\n    \\\"email\\\": \\\"test@example.com\\\",\\n    \\\"first_name\\\": \\\"James\\\",\\n    \\\"last_name\\\": \\\"Test\\\",\\n    \\\"cv_file\\\": \\\"\\\",\\n\\t  \\\"location\\\": {\\n  \\t  \\\"city\\\": \\\"London\\\",\\n\\t    \\\"country\\\": \\\"UK\\\",\\n  \\t  \\\"zipcode\\\": \\\"EC1R 5DT\\\"\\n\\t  }\\n  },\\n  \\\"applications\\\": [{\\n  \\t\\\"job_id\\\": \\\"1234\\\"\\n  }]\\n}\",\n      \"language\": \"http\"\n    },\n    {\n      \"code\": \"import json\\nimport requests\\n\\nconnector_id = '123'\\nusername = 'username'\\npassword = 'password'\\n\\nurl = \\\"https://api.rolepoint-connect.com/v1/{}/candidate\\\".format(\\n  connector_id\\n)\\n\\nheaders = {\\n  \\\"content-type\\\": \\\"application/rolepoint.v2+json\\\",\\n  \\\"accept\\\": \\\"application/rolepoint.v2+json\\\",\\n  'X-RolePoint-Callback-Url': 'https://example.com/send-candidate-callback'\\n}\\n\\npayload = json.dumps({\\n  \\\"source\\\": \\\"example\\\",\\n  \\\"candidate\\\": {\\n    \\\"email\\\": \\\"test@example.com\\\",\\n    \\\"first_name\\\": \\\"James\\\",\\n    \\\"last_name\\\": \\\"Test\\\",\\n    \\\"cv_file\\\": \\\"\\\",\\n\\t  \\\"location\\\": {\\n  \\t  \\\"city\\\": \\\"London\\\",\\n\\t    \\\"country\\\": \\\"UK\\\",\\n  \\t  \\\"zipcode\\\": \\\"EC1R 5DT\\\"\\n\\t  }\\n  },\\n  \\\"applications\\\": [{\\n  \\t\\\"job_id\\\": \\\"1234\\\"\\n  }]\\n})\\n\\nresponse = requests.post(\\n  url, data=payload, headers=headers, auth=(username, password)\\n)\\n\\nprint(response.text)\",\n      \"language\": \"python\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"## Final Result\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \" HTTP/1.1 200 OK\\n Status: 200 OK\\n Content-Type: application/rolepoint.v2+json\\n\\n{\\n  \\\"candidate_id\\\": 1234,\\n  \\\"candidate_created\\\": True\\n  \\\"application_ids\\\": {\\n\\t  \\\"1234\\\": 4675\\n  }\\n}\",\n      \"language\": \"http\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Asynchronous Endpoint\",\n  \"body\": \"This endpoint is asynchronous. See the [Asynchronous Requests](doc:asynchronous-requests) documentation for more details.\"\n}\n[/block]\n## Request Body\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"candidate\",\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Description\",\n    \"0-1\": \"[Candidate](doc:resources)\",\n    \"0-2\": \"True\",\n    \"0-3\": \"The Candidate entity the application(s) is for.\",\n    \"1-0\": \"applications\",\n    \"1-1\": \"list<[Application](doc:application)>\",\n    \"1-2\": \"True\",\n    \"1-3\": \"The job(s) the Candidate is applying for.\",\n    \"2-0\": \"source\",\n    \"2-1\": \"string\",\n    \"2-2\": \"False\",\n    \"2-3\": \"The ID which specifies the source that the application was made through.\"\n  },\n  \"cols\": 4,\n  \"rows\": 3\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Potential Errors\",\n  \"body\": \"The endpoint can return errors if the payload is malformed. The response\\nin this case will contain the following fields:\\n\\n    PUT /v1/123/candidate HTTP/1.1\\n\\n    HTTP/1.1 422 Unprocessable Entity\\n    Status: 422 Unprocessable Entity\\n\\n    {\\n        \\\"message\\\": \\\"JSON does not match expected schema\\\",\\n        \\\"errors\\\": [\\n            \\\"empty values not allowed for field 'first_name'\\\",\\n            \\\"empty values not allowed for field 'last_name'\\\"\\n        ]\\n    }\"\n}\n[/block]","githubsync":"","link_url":"","version":"569e609aebbadc0d0079bed0","editedParams2":true,"excerpt":"Endpoint for creating a job application.","order":0,"type":"post","user":"543d38fea10ab32000b3aa8f","sync_unique":"","title":"Send Candidate","editedParams":true,"link_external":false,"parentDoc":null,"slug":"send-candidate","childrenPages":[]}

postSend Candidate

Endpoint for creating a job application.

Body Params

connector_id:
string
The ID of your Connector.
[block:textarea] { "text": "## Request", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "POST /v1/123/candidate HTTP/1.1\nHost: api.rolepoint-connect.com\nAccept: application/rolepoint.v2+json\nContent-Type: application/rolepoint.v2+json\nAuthorization: xxxxx\nX-RolePoint-Callback-Url: https://example.com/send-candidate-callback\n\n{\n \"source\": \"example\",\n \"candidate\": {\n \"email\": \"test@example.com\",\n \"first_name\": \"James\",\n \"last_name\": \"Test\",\n \"cv_file\": \"\",\n\t \"location\": {\n \t \"city\": \"London\",\n\t \"country\": \"UK\",\n \t \"zipcode\": \"EC1R 5DT\"\n\t }\n },\n \"applications\": [{\n \t\"job_id\": \"1234\"\n }]\n}", "language": "http" }, { "code": "import json\nimport requests\n\nconnector_id = '123'\nusername = 'username'\npassword = 'password'\n\nurl = \"https://api.rolepoint-connect.com/v1/{}/candidate\".format(\n connector_id\n)\n\nheaders = {\n \"content-type\": \"application/rolepoint.v2+json\",\n \"accept\": \"application/rolepoint.v2+json\",\n 'X-RolePoint-Callback-Url': 'https://example.com/send-candidate-callback'\n}\n\npayload = json.dumps({\n \"source\": \"example\",\n \"candidate\": {\n \"email\": \"test@example.com\",\n \"first_name\": \"James\",\n \"last_name\": \"Test\",\n \"cv_file\": \"\",\n\t \"location\": {\n \t \"city\": \"London\",\n\t \"country\": \"UK\",\n \t \"zipcode\": \"EC1R 5DT\"\n\t }\n },\n \"applications\": [{\n \t\"job_id\": \"1234\"\n }]\n})\n\nresponse = requests.post(\n url, data=payload, headers=headers, auth=(username, password)\n)\n\nprint(response.text)", "language": "python" } ], "sidebar": true } [/block] [block:textarea] { "text": "## Final Result", "sidebar": true } [/block] [block:code] { "codes": [ { "code": " HTTP/1.1 200 OK\n Status: 200 OK\n Content-Type: application/rolepoint.v2+json\n\n{\n \"candidate_id\": 1234,\n \"candidate_created\": True\n \"application_ids\": {\n\t \"1234\": 4675\n }\n}", "language": "http" } ], "sidebar": true } [/block] [block:callout] { "type": "info", "title": "Asynchronous Endpoint", "body": "This endpoint is asynchronous. See the [Asynchronous Requests](doc:asynchronous-requests) documentation for more details." } [/block] ## Request Body [block:parameters] { "data": { "0-0": "candidate", "h-0": "Attribute", "h-1": "Type", "h-2": "Required", "h-3": "Description", "0-1": "[Candidate](doc:resources)", "0-2": "True", "0-3": "The Candidate entity the application(s) is for.", "1-0": "applications", "1-1": "list<[Application](doc:application)>", "1-2": "True", "1-3": "The job(s) the Candidate is applying for.", "2-0": "source", "2-1": "string", "2-2": "False", "2-3": "The ID which specifies the source that the application was made through." }, "cols": 4, "rows": 3 } [/block] [block:callout] { "type": "warning", "title": "Potential Errors", "body": "The endpoint can return errors if the payload is malformed. The response\nin this case will contain the following fields:\n\n PUT /v1/123/candidate HTTP/1.1\n\n HTTP/1.1 422 Unprocessable Entity\n Status: 422 Unprocessable Entity\n\n {\n \"message\": \"JSON does not match expected schema\",\n \"errors\": [\n \"empty values not allowed for field 'first_name'\",\n \"empty values not allowed for field 'last_name'\"\n ]\n }" } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:textarea] { "text": "## Request", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "POST /v1/123/candidate HTTP/1.1\nHost: api.rolepoint-connect.com\nAccept: application/rolepoint.v2+json\nContent-Type: application/rolepoint.v2+json\nAuthorization: xxxxx\nX-RolePoint-Callback-Url: https://example.com/send-candidate-callback\n\n{\n \"source\": \"example\",\n \"candidate\": {\n \"email\": \"test@example.com\",\n \"first_name\": \"James\",\n \"last_name\": \"Test\",\n \"cv_file\": \"\",\n\t \"location\": {\n \t \"city\": \"London\",\n\t \"country\": \"UK\",\n \t \"zipcode\": \"EC1R 5DT\"\n\t }\n },\n \"applications\": [{\n \t\"job_id\": \"1234\"\n }]\n}", "language": "http" }, { "code": "import json\nimport requests\n\nconnector_id = '123'\nusername = 'username'\npassword = 'password'\n\nurl = \"https://api.rolepoint-connect.com/v1/{}/candidate\".format(\n connector_id\n)\n\nheaders = {\n \"content-type\": \"application/rolepoint.v2+json\",\n \"accept\": \"application/rolepoint.v2+json\",\n 'X-RolePoint-Callback-Url': 'https://example.com/send-candidate-callback'\n}\n\npayload = json.dumps({\n \"source\": \"example\",\n \"candidate\": {\n \"email\": \"test@example.com\",\n \"first_name\": \"James\",\n \"last_name\": \"Test\",\n \"cv_file\": \"\",\n\t \"location\": {\n \t \"city\": \"London\",\n\t \"country\": \"UK\",\n \t \"zipcode\": \"EC1R 5DT\"\n\t }\n },\n \"applications\": [{\n \t\"job_id\": \"1234\"\n }]\n})\n\nresponse = requests.post(\n url, data=payload, headers=headers, auth=(username, password)\n)\n\nprint(response.text)", "language": "python" } ], "sidebar": true } [/block] [block:textarea] { "text": "## Final Result", "sidebar": true } [/block] [block:code] { "codes": [ { "code": " HTTP/1.1 200 OK\n Status: 200 OK\n Content-Type: application/rolepoint.v2+json\n\n{\n \"candidate_id\": 1234,\n \"candidate_created\": True\n \"application_ids\": {\n\t \"1234\": 4675\n }\n}", "language": "http" } ], "sidebar": true } [/block] [block:callout] { "type": "info", "title": "Asynchronous Endpoint", "body": "This endpoint is asynchronous. See the [Asynchronous Requests](doc:asynchronous-requests) documentation for more details." } [/block] ## Request Body [block:parameters] { "data": { "0-0": "candidate", "h-0": "Attribute", "h-1": "Type", "h-2": "Required", "h-3": "Description", "0-1": "[Candidate](doc:resources)", "0-2": "True", "0-3": "The Candidate entity the application(s) is for.", "1-0": "applications", "1-1": "list<[Application](doc:application)>", "1-2": "True", "1-3": "The job(s) the Candidate is applying for.", "2-0": "source", "2-1": "string", "2-2": "False", "2-3": "The ID which specifies the source that the application was made through." }, "cols": 4, "rows": 3 } [/block] [block:callout] { "type": "warning", "title": "Potential Errors", "body": "The endpoint can return errors if the payload is malformed. The response\nin this case will contain the following fields:\n\n PUT /v1/123/candidate HTTP/1.1\n\n HTTP/1.1 422 Unprocessable Entity\n Status: 422 Unprocessable Entity\n\n {\n \"message\": \"JSON does not match expected schema\",\n \"errors\": [\n \"empty values not allowed for field 'first_name'\",\n \"empty values not allowed for field 'last_name'\"\n ]\n }" } [/block]
{"_id":"56e18912686c7d20008606d0","createdAt":"2016-03-10T14:47:46.450Z","excerpt":"Get the result of calling POST candidate","isReference":true,"link_url":"","parentDoc":null,"slug":"send-candidate-result","sync_unique":"","api":{"auth":"required","examples":{"codes":[{"language":"http","code":"GET /123/applications/f586c5aa-842d-4e49-bcca-876a11e82ede/result HTTP/1.1\nHost: api.rolepoint-connect.com\nAccept: application/rolepoint.v2+json\nAuthorization: xxxxx"},{"language":"python","code":"import json\nimport requests\n\nconnector_id = '123'\nusername = 'username'\npassword = 'password'\nrequest_id = ''\n\nurl = \"https://api.rolepoint-connect.com/v1/{}/applications/{}/result\".format(\n  connector_id, request_id\n)\n\nresponse = requests.get(\n  url, auth=(username, password)\n)\n\nprint(response.text)"}]},"method":"get","params":[{"ref":"","required":false,"desc":"The ID of your connector","default":"","type":"string","name":"connector_id","in":"query","_id":"56e18912686c7d20008606d2"},{"type":"string","name":"request_id","in":"path","_id":"56e18912686c7d20008606d1","ref":"","required":false,"desc":"The ID of the asynchronous request as returned in the initial request.","default":""}],"results":{"codes":[{"name":"Success Result","status":200,"language":"json","code":"{\n  \"candidate_id\": 1234,\n  \"candidate_created\": True\n  \"application_ids\": {\n    \"1234\": 4675\n  }\n}"}]},"settings":"","url":"/applications/:request_id/result"},"type":"get","title":"Send Candidate Result","category":"56d8457a9d27560b00a4cc17","githubsync":"","order":1,"version":"569e609aebbadc0d0079bed0","editedParams2":true,"hidden":false,"project":"569e6099ebbadc0d0079becd","editedParams":true,"body":"Once application creation is finished, you can get the result using the\n`result_info.url` field returned in the status (either from a callback or the complete status).  You should issue a `GET` request to that URL