Get Assessments | POP Engine™ Partner API

Get list of assessments

Request a list of incomplete assessments belonging to your account.

Request body parameters

command

string required

Set to "application_get".

partner_api

boolean required

Set to true.

max_count

integer int64

Maximum number of results to return. Minimum 2, maximum 1000. Defaults to 1000 if not specified.

start_id

string

Checkpoint for requesting subsequent batches of assessments in excess of max_count; set to the value of next_app_id returned by previous request.

start_acc_id

string

Checkpoint for requesting subsequent batches of assessments in excess of max_count; set to the value of next_acc_id returned by previous request.

start_date

string

Checkpoint for requesting subsequent batches of assessments in excess of max_count; set to the value of next_date returned by previous request.

{ "command": "application_get", "partner_api": true }

{ "command": "application_get", "partner_api": true, "start_id": "30000000", "start_acc_id": "30000099", "start_date": "2024-01-01" }

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_get")

count

integer int64

Number of assessments returned

has_more

boolean

Whether additional assessments exist in excess of the maximum number of results for this request. If true, response will also include next_app_id, next_acc_id and next_date for building a follow-up request.

next_app_id

string

Present if additional assessments are available; set start_id to this value to request the next batch

next_acc_id

string

Present if additional assessments are available; set start_acc_id to this value to request the next batch

next_date

string

Present if additional assessments are available; set start_date to this value to request the next batch

too_big

boolean

Whether the total number of assessments available is in excess of 10000

application_list

Array of object

Assessment data

_{Child attributes}

application_id

integer int64

ID of assessment

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

started

string YYYY-MM-DD

Date of invitation/assessment creation

expires

string YYYY-MM-DD

Expiry date of application; questionnaire is not completable after this date.

completed

string YYYY-MM-DD

Date assessment was completed by candidate. If not complete, the completed date will be 1900-01-01.

app_link_full

string

Present if assessment is incomplete; URL of the questionnaire to be filled in by applicant

rep_link_full

string

Present if assessment is complete. URL of the assessment report

fields

string

Bar-separated field string; Personal/custom data for assessment, such as candidate name and email

{ "error_code": 0, "error_text": "", "command_from": "application_get", "count": "161", "has_more": false, "too_big": false, "application_list": [ { "application_id": "30000099", "converted_from": "0", "account_id": "20000000", "position_id": "20000100", "position": "POPS Sales", "started": "2024-01-28", "expires": "2034-01-28", "completed": "2024-01-31", "fields": "app_full_name|Jason Candidate|email|[email protected]", "rep_link_full": "https:// ..." }, . . . ] }

{ "error_code": 0, "error_text": "", "command_from": "application_get", "count": "1000", "has_more": true, "next_app_id": "10001999", "next_acc_id": "10231999", "next-date": "2024-03-05", "too_big": false, "application_list": [ { "application_id": "30000100", "converted_from": "0", "account_id": "20000000", "position_id": "20000100", "position": "POPS Sales", "started": "2024-01-28", "expires": "2034-01-28", "completed": "2024-01-31", "fields": "app_full_name|Paula Candidate|email|[email protected]", "rep_link_full": "https:// ..." }, . . . ] }

Get one assessment

Request details about a specific assessment.

Request body parameters

command

string required

Set to "application_get".

partner_api

boolean required

Set to true.

application_id

integer int64 or string required

ID of assessment to request

{ "command": "application_get", "partner_api": true, "application_id": "10009999" }

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_get")

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

user_id

string

Username of the user who sent the assessment invitation

language_id

string

3-letter language code assigned to the assessment

status

string

Status of assessment: "pending", "expired" or "completed"

started

string YYYY-MM-DD

Date of invitation/assessment creation

completed

string YYYY-MM-DD

Present if status="completed". 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.

app_link_full

string

URL of the questionnaire to be filled in by applicant

rep_link_full

string

Present if status="completed". URL of the assessment report

rep_link_full_acc

string

Present if status="completed" and if available for specific assessment type. URL to alternative version of assessment report. Check with SMG rep for availability.

fields

Array of object

Array of custom field objects configured for partner account where each element of the array if a name/value pair

_{Child attributes}

[field name]

string

Field value

{ "error_code": 0, "error_text": "", "command_from": "application_get", "application_id": "10009999", "started": "2021-08-30", "status": "completed", "completed": "2021-08-30", "fields": [ { "app_email": "[email protected]" }, { "app_full_name": "Calvin Candidate" }, { "app_phone": "111-111-1111" } ], "rep_link_full": "https://pop.selfmgmt.com/static/app_link/app_link.html?app_link=XXXXXXXX&acc_link=XXXXXXXX", "rep_link_full_acc": "https://pop.selfmgmt.com/static/app_link/app_link.html?app_link=XXXXXXXX&acc_link=XXXXXXXX&postfix=XXXXXXXX" }