Back to top

Criteria Corp. API Documentation

This is the core API for all Criteria Corp services. HireSelect, Intranet, and ODA will all be able to pull from this API. Eventually, certain endpoints will be opened to the public to facilitate integrations and deeper partnerships.

login

This is the method to login to HireSelect.

login Collection

Login
POST/login

  • emailAddress (string) - The user’s email address

  • password (string) - The user’s password

Example URI

POST /login
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "emailAddress": "test@example.com",
  "password": "ThisIsThePassword"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "api_token": "API_TOKEN_VALUE",
  "status": "subscriber",
  "daysRemaining": 100,
  "expired": 0,
  "paid": 0,
  "paidFirstPayment": 0,
  "invoiceNumber": 1000,
  "rep": {
    "firstName": "AMFirst",
    "lastName": "AMLast",
    "emailAddress": "am@criteriacorp.com",
    "extension": 100
  }
}

applications

Applications can be customized and delivered to candidates.

applications Collection

List All Applications
(409) 722-7118/applications

Example URI

GET /applications
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "applicationId": 1665,
      "userAccountId": 57659,
      "applicationName": "Test Application",
      "applicationDescription": "This is a description of the test application.",
      "applicationDateCreated": "2015-03-23 08:50:42",
      "applicationInstructions": "Please fill this out.",
      "active": 1
    }
  ]
}

Create an Application
POST/applications

  • applicationName (string) - The name of the application

  • applicationDescription (string) - A description of the application

  • applicationInstructions (string) - Instructions that are given to the candidate prior to beginning

  • active (tinyint) - Whether this application is active

Example URI

POST /applications
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "applicationName": "Application Name",
  "applicationDescription": "This is a description.",
  "applicationInstructions": "These are the instructions.",
  "active": 1
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "applicationId": 1665,
      "userAccountId": 57659,
      "applicationName": "Application Name",
      "applicationDescription": "This is a description.",
      "applicationDateCreated": "2015-03-23 08:50:42",
      "applicationInstructions": "These are the instructions.",
      "active": 1
    }
  ]
}

applications

View an Application
GET/applications/{applicationId}

Example URI

GET /applications/applicationId
URI Parameters
HideShow
applicationId
int (required) 

ID of the application in the form of an integer

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "applicationId": 1665,
      "userAccountId": 57659,
      "applicationName": "Test Application",
      "applicationDescription": "This is a description of the test application.",
      "applicationDateCreated": "2015-03-23 08:50:42",
      "applicationInstructions": "Please fill this out.",
      "active": 1
    }
  ]
}

Update an Application
PUT/applications/{applicationId}

Example URI

PUT /applications/applicationId
URI Parameters
HideShow
applicationId
int (required) 

ID of the application in the form of an integer

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "applicationName": "Application Name",
  "applicationDescription": "This is a description.",
  "applicationInstructions": "These are the instructions.",
  "active": 1
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "applicationId": 1665,
      "userAccountId": 57659,
      "applicationName": "Application Name",
      "applicationDescription": "This is a description.",
      "applicationDateCreated": "2015-03-23 08:50:42",
      "applicationInstructions": "These are the instructions.",
      "active": 1
    }
  ]
}

Delete an Email Template
6614032014/applications/{applicationId}

Example URI

DELETE /applications/applicationId
URI Parameters
HideShow
applicationId
int (required) 

ID of the application in the form of an integer

Response  200

Application Questions

List
(401) 229-1690/applications/{applicationId}/questions

Example URI

GET /applications/applicationId/questions
URI Parameters
HideShow
applicationId
int (required) 

ID of the application in the form of an integer

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 51806,
      "applicationQuestionId": 72,
      "label": "Name",
      "required": 0,
      "linked": 0,
      "linkedQuestionId": 0,
      "linkedQuestionOperator": "0",
      "linkedQuestionValue": "0",
      "applicationSelectListId": 0,
      "questionOrder": 1
    },
    {
      "id": 51807,
      "applicationQuestionId": 88,
      "label": "First name:",
      "required": 0,
      "linked": 0,
      "linkedQuestionId": null,
      "linkedQuestionOperator": null,
      "linkedQuestionValue": null,
      "applicationSelectListId": null,
      "questionOrder": 2
    }
  ]
}

emailTemplates

E-mail Templates are form emails that can be customized with merge fields and sent to candidates.

emailTemplates Collection

List All Email Templates
GET/emailTemplates

Example URI

GET /emailTemplates
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "emailTemplateId": 1,
      "userAccountId": 57659,
      "emailTemplateDate": "2015-05-07 17:34:56",
      "emailName": "Phone Interview Template",
      "emailDescription": null,
      "emailSubject": "Phone Interview - {[firstName]}",
      "emailBody": "<p>Email body goes here</p>",
      "senderAlias": ""
    }
  ]
}

Create an Email Template
POST/emailTemplates

  • emailName (string) - The name of the test battery

  • emailSubject (string) - The subject line for the email

  • emailBody (string) - The body text of the email

Example URI

POST /emailTemplates
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "emailName": "Unit Testing Email Template",
  "userAccountId": 57659,
  "emailSubject": "Unit Testing Email Subject",
  "emailBody": "<p>Unit Testing Email Body.</p>"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
    "data":[
    {
        "emailTemplateId":1,
        "userAccountId":57659,
        "emailTemplateDate":"2015-05-07 17:34:56",
        "emailName":"Phone Interview Template",
        "emailDescription":null,
        "emailSubject":"Phone Interview - {[firstName]}",
        "emailBody":"<p>Email body goes here<\/p>",
        "senderAlias":""
    }
}

emailTemplates

View an Email Template
620-399-5619/emailTemplates/{emailTemplateId}

Example URI

GET /emailTemplates/emailTemplateId
URI Parameters
HideShow
emailTemplateId
int (required) 

ID of the test battery in the form of an integer

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "emailTemplateId": 1,
      "userAccountId": 57659,
      "emailTemplateDate": "2015-05-07 17:34:56",
      "emailName": "Phone Interview Template",
      "emailDescription": null,
      "emailSubject": "Phone Interview - {[firstName]}",
      "emailBody": "<p>Email body goes here</p>",
      "senderAlias": ""
    }
  ]
}

Update an Email Template
PUT/emailTemplates/{emailTemplateId}

Example URI

PUT /emailTemplates/emailTemplateId
URI Parameters
HideShow
emailTemplateId
int (required) 

ID of the test battery in the form of an integer

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "emailName": "Unit Testing Email Template",
  "userAccountId": 57659,
  "emailSubject": "Unit Testing Email Subject",
  "emailBody": "<p>Unit Testing Email Body.</p>"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "emailTemplateId": 1,
      "userAccountId": 57659,
      "emailTemplateDate": "2015-05-07 17:34:56",
      "emailName": "Phone Interview Template",
      "emailDescription": null,
      "emailSubject": "Phone Interview - {[firstName]}",
      "emailBody": "<p>Email body goes here</p>",
      "senderAlias": ""
    }
  ]
}

Delete an Email Template
DELETE/emailTemplates/{emailTemplateId}

Example URI

DELETE /emailTemplates/emailTemplateId
URI Parameters
HideShow
emailTemplateId
int (required) 

ID of the test battery in the form of an integer

Response  200

testBatteries

Test Batteries contain one or more tests to be delivered to candidates.

testBatteries Collection

List All testBatteries
GET/testBatteries

Example URI

GET /testBatteries
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "testBatteryId": 55608,
      "testBatteryName": "Software Developer Test Battery",
      "testBatteryDescription": "This is the description of this Test Battery. It's got a lot of stuff going on here.",
      "userAccountId": 57659,
      "share": null,
      "uploadResume": 0,
      "applicationId": null,
      "socCode": "15-1031.00",
      "enablePosition": 1,
      "verticalSelect": 0,
      "hidePosition": null,
      "requestLinkedIn": 0,
      "profileId": 1928,
      "profileAddedDate": null,
      "fromDashboard": null,
      "dateCreated": null,
      "inactive": null,
      "subTests": {
        "data": [
          {
            "subTestId": 1,
            "subTestName": "Criteria Cognitive Aptitude Test",
            "subTestAbbreviation": "CCAT",
            "subTestOrder": 1
          },
          {
            "subTestId": 43,
            "subTestName": "Employee Personality Profile",
            "subTestAbbreviation": "EPP",
            "subTestOrder": 2
          }
        ]
      }
    }
  ]
}

Create a Test Battery
9379100694/testBatteries

  • testBatteryName (string) - The name of the test battery

  • testBatteryDescription (string) - A description of the test battery

  • subTests (array) - The subTestIds for tests in this test battery

Example URI

POST /testBatteries
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "testBatteryName": "Software Developer Test Battery",
  "testBatteryDescription": "This is the description of this Test Battery. It's got a lot of stuff going on here.",
  "subTests": [
    {
      "subTestId": 57,
      "subTestOrder": 1
    },
    {
      "subTestId": 43,
      "subTestOrder": 2
    }
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "testBatteryId": 55608,
      "testBatteryName": "Software Developer Test Battery",
      "testBatteryDescription": "This is the description of this Test Battery. It's got a lot of stuff going on here.",
      "userAccountId": 57659,
      "share": null,
      "uploadResume": 0,
      "applicationId": null,
      "socCode": "15-1031.00",
      "enablePosition": 1,
      "verticalSelect": 0,
      "hidePosition": null,
      "requestLinkedIn": 0,
      "profileId": 1928,
      "profileAddedDate": null,
      "fromDashboard": null,
      "dateCreated": null,
      "inactive": null,
      "subTests": {
        "data": [
          {
            "subTestId": 1,
            "subTestName": "Criteria Cognitive Aptitude Test",
            "subTestAbbreviation": "CCAT",
            "subTestOrder": 1
          },
          {
            "subTestId": 43,
            "subTestName": "Employee Personality Profile",
            "subTestAbbreviation": "EPP",
            "subTestOrder": 2
          }
        ]
      }
    }
  ]
}

testBatteries

View a Test Battery
GET/testBatteries/{testBatteryId}

Example URI

GET /testBatteries/testBatteryId
URI Parameters
HideShow
testBatteryId
int (required) 

ID of the test battery in the form of an integer

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "testBatteryId": 55608,
      "testBatteryName": "Software Developer Test Battery",
      "testBatteryDescription": "This is the description of this Test Battery. It's got a lot of stuff going on here.",
      "userAccountId": 57659,
      "share": null,
      "uploadResume": 0,
      "applicationId": null,
      "socCode": "15-1031.00",
      "enablePosition": 1,
      "verticalSelect": 0,
      "hidePosition": null,
      "requestLinkedIn": 0,
      "profileId": 1928,
      "profileAddedDate": null,
      "fromDashboard": null,
      "dateCreated": null,
      "inactive": null,
      "subTests": {
        "data": [
          {
            "subTestId": 1,
            "subTestName": "Criteria Cognitive Aptitude Test",
            "subTestAbbreviation": "CCAT",
            "subTestOrder": 1
          },
          {
            "subTestId": 43,
            "subTestName": "Employee Personality Profile",
            "subTestAbbreviation": "EPP",
            "subTestOrder": 2
          }
        ]
      }
    }
  ]
}

Update a Test Battery
PUT/testBatteries/{testBatteryId}

Example URI

PUT /testBatteries/testBatteryId
URI Parameters
HideShow
testBatteryId
int (required) 

ID of the test battery in the form of an integer

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "testBatteryName": "Software Developer Test Battery",
  "testBatteryDescription": "This is the description of this Test Battery. It's got a lot of stuff going on here.",
  "subTests": [
    {
      "subTestId": 57,
      "subTestOrder": 1
    },
    {
      "subTestId": 43,
      "subTestOrder": 2
    }
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "testBatteryId": 55608,
      "testBatteryName": "Software Developer Test Battery",
      "testBatteryDescription": "This is the description of this Test Battery. It's got a lot of stuff going on here.",
      "userAccountId": 57659,
      "share": null,
      "uploadResume": 0,
      "applicationId": null,
      "socCode": "15-1031.00",
      "enablePosition": 1,
      "verticalSelect": 0,
      "hidePosition": null,
      "requestLinkedIn": 0,
      "profileId": 1928,
      "profileAddedDate": null,
      "fromDashboard": null,
      "dateCreated": null,
      "inactive": null,
      "subTests": {
        "data": [
          {
            "subTestId": 1,
            "subTestName": "Criteria Cognitive Aptitude Test",
            "subTestAbbreviation": "CCAT",
            "subTestOrder": 1
          },
          {
            "subTestId": 43,
            "subTestName": "Employee Personality Profile",
            "subTestAbbreviation": "EPP",
            "subTestOrder": 2
          }
        ]
      }
    }
  ]
}

Delete a Test Battery
DELETE/testBatteries/{testBatteryId}

Example URI

DELETE /testBatteries/testBatteryId
URI Parameters
HideShow
testBatteryId
int (required) 

ID of the test battery in the form of an integer

Response  200

Generated by 202-718-0342 on 30 May 2017