Create assessment

Request body parameters

command

string required

Set to "application_create".

partner_api

boolean required

Set to true.

position_id

integer int64 required

Any position_id returned by Get assessment types command

language_id

string

Any supported 3-letter language code, eg. "eng". This is the initial language in which the questionnaire will be presented to the candidate, and the initial language in which the report will be displayed. Consult SMG for information about which languages are available for each assessment.

app_email

string

If present, an invitation email with a link to complete the questionnaire will be emailed to the candidate. (If omitted it becomes the partner's responsibility to provide the candidate with the questionnaire link.)

app_phone

string

Phone number given as a sequence of digits without spaces or demarcations such as () and -. If present the applicant will receive an SMS containing a link to the questionnaire.

app_url

string

If present, will override the account-level callback url for this specific application. (See Account Config) Note that the [___API_ID___] substitution field is required for this field.

is_test

boolean

If present and true, assessment will be flagged as test data. Please set this option for any assessments generated when testing integration.

fail_on_dup

boolean

If present and true, assessment creation will fail if any assessments already exist for this candidate, identified based on their email address. See Create application with duplicates forbidden

Response body JSON

error_code

integer int64

Error code

error_text

string

Error text

command_from

string

The command used to generate this response ("application_create")

application_id

string

ID of the created application to be used in subsequent commands

app_link_full

string

URL of the questionnaire to be filled in by applicant

Error codes

Request body parameters

command

string required

Set to "application_create".

partner_api

boolean required

Set to true.

position_id

integer int64 required

Any position_id returned by Get assessment types command

language_id

string

Any supported 3-letter language code, eg. "eng". This is the initial language in which the questionnaire will be presented to the candidate, and the initial language in which the report will be displayed. Consult SMG for information about which languages are available for each assessment.

fields

Array of object

Array of arbitrary name/value pairs. When making an extensible request, app_email, app_full_name, app_phone and app_url fields can be included in this array and function the same as in a simple Create application request.

_{Child attributes}

n

string required

Name of the field

v

string required

Value of the field

is_test

boolean

If present and true, assessment will be flagged as test data. Please set this option for any assessments generated when testing integration.

fail_on_dup

boolean

If present and true, assessment creation will fail if any assessments already exist for this candidate, identified based on their email address. See Create application with duplicates forbidden

Response body JSON

error_code

integer int64

Error code

error_text

string

Error text

command_from

string

The command used to generate this response ("application_create")

application_id

string

ID of the created application to be used in subsequent commands

app_link_full

string

URL of the questionnaire to be filled in by applicant

Error codes

Response body JSON when duplicates found

error_code

integer int64

Error code; "1726" for this response

error_text

string

Error text

command_from

string

The command used to generate this response ("application_create")

duplicates

Array of object

Duplicate applications

_{Child attributes}

application_id

integer int64

ID of assessment which was requested

converted_from

string

ID of source assessment if converted from another assessment; "0" if not a converted assessment

account_id

string

ID of this assessment's account

position_id

string

ID of assessment type

position

string

Name of assessment type

language_id

string

3-letter language code assigned to the assessment

started

string YYYY-MM-DD

Date of invitation/assessment creation

completed

string YYYY-MM-DD

Date assessment is completed by candidate.

expires

string YYYY-MM-DD

Present if status="pending". Expiry date of application; questionnaire is not completable after this date.

fields

string Bar-separated fields Preset custom fields for assessment, such as candidate's name and email