Get questions

Command:: application_get_q

Get score/results of an assessment.

Request body parameters

command

string required

Set to "application_get_q".

language_id

string

3-character language code. Consult SMG rep for available languages for particular assessment type. If omitted, questions are returned in the language that was assigned when application was created.

app_link

string required

Value of the "app_link" query parameter. It can be extracted from the "app_link_full" field returned as part of the response to a Create application or Assessment status request

ignore_submitted_over

boolean

Set to true to suppress a "Questionnaire already complete" error and return questions even if questionnaire is complete

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

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

already_submitted

boolean

True if assessment is already completed; when true, the remaining fields below aren't included in response

report_name_has

boolean

Whether a name is available for this assessment type

report_name

string

Name of assessment type

language_id

string

3-letter code of language in which questionnaire is being presented

submit_link

string

URL target for submitting answers for this questionnaire

fields

string

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

custom_fld_list

Array of object

List of custom fields that must be submitted along with this questionnaire

_{Child attributes}

aname

string

Name of the custom field

caption_tr

string

Title of the custom field, translated into the requested language

mandatory

boolean

Whether a value for this field must be submitted for this assessment; not submitting a value will generate a 1716 error

partner

boolean

Whether the field must be filled in by partner when issuing the invitation with a Create application request

applicant

integer

If "1", the field must be submitted along with the candidate's answers in a Submit answers request

hidden

boolean

For "applicant" fields: whether the field is typically hidden from candidates when they complete the questionnaire; i.e. it should be pre-filled by the system presenting the questionnaire instead of presented to candidate to fill in themselves

value

string

Any existing value assigned to the field when questionnaire was created

qgroup_list

Array of object

Array of groups of questions in the questionnaire

_{Child attributes}

qgroup_id

string

ID of the question group/p>

aname

string

Internal name of question group

caption_tr

boolean

Title and instructions, translated into specified language

group_item_list

Array of object

List of common multiple-choice answers for questions in group

_{Child attributes}

item_no

integer int64

Choice number

avalue

integer int64

Score for choice

caption_tr

string

Label for choice, translated into requested language

question_list

Array of object

Questions in section

_{Child attributes}

question_id

string

ID of question

question_type_id

string

Value representing the type of question (i.e. multiple-choice, text, etc.)

caption_tr

string

Question text, translated into requested language

question_item_list

string Array of object

Answer choices specific to this question, if not using group items

_{Child attributes}

item_no

integer int64

Choice number

avalue

integer int64

Score for choice

caption_tr

string

Label for choice, translated into requested language

translations

Array of object

Utility text for questionnaire

_{Child attributes}

a

string

Name of text item

v

string

Internal ID of text item

t

string

Text item, translated into requested language

rep_config

string

Bar-separated field string; Custom presentation information for client, such as a custom logo

{ "error_code": 0, "error_text": "", "command_from": "application_get_q", "report_name_has": true, "report_name": "POPS", "rep_config": "vrep_logo|CustomLogo.png", "language_id": "eng", "submit_link": "https://pop.selfmgmt.com/app_link/app_link.html?app_link=XXXXXXXX", "fields": "email|[email protected]|app_full_name|Alice Candidate", "custom_fld_list": [ { "aname": "email", "caption_tr": "Email", "mandatory": true, "atype": 1, "atype_tag": 60, "hidden": true, "partner": true, "applicant": 1, "value": "[email protected]" }, { "aname": "app_full_name", "caption_tr": "Full Name", "mandatory": true, "atype": 1, "atype_tag": 60, "hidden": true, "partner": true, "applicant": 1, "value": "" } ], "qgroup_list": [ { "qgroup_id": "500", "aname": "opinions_sales_6", "caption_tr": "Here are some examples of opinions that people will often express. Please think about these statements in relation to yourself and indicate your agreement or disagreement with EACH statement. Please respond to EVERY item.", "group_item_list": [ { "item_no": 1, "avalue": 0, "caption_tr": "Don't agree at all" }, { "item_no": 2, "avalue": 1, "caption_tr": "Agree a little" }, { "item_no": 3, "avalue": 3, "caption_tr": "Somewhat agree" }, { "item_no": 4, "avalue": 5, "caption_tr": "Moderately agree" }, { "item_no": 5, "avalue": 7, "caption_tr": "Definitely agree" } ], "question_list": [ { "question_id": "10022744", "question_type_id": "16777317", "caption_tr": "To be a successful salesperson, it is necessary to get potential buyers to like me.", "question_item_list": [] }, { "question_id": "10022746", "question_type_id": "16777317", "caption_tr": "It is very important to push people to buy a product or service after you have established that they need it.", "question_item_list": [] }, { "question_id": "10022748", "question_type_id": "16777317", "caption_tr": "I get upset when salespeople call me at home.", "question_item_list": [] }, { "question_id": "10022750", "question_type_id": "16777317", "caption_tr": "Salespeople have a positive public image.", "question_item_list": [] }, { "question_id": "10022752", "question_type_id": "16777317", "caption_tr": "Most people would prefer not to deal with salespeople any more than necessary.", "question_item_list": [] }, { "question_id": "10022754", "question_type_id": "16777317", "caption_tr": "I have bought a product or service mainly because of the salesperson.", "question_item_list": [] } ] }, ], "translations": [ { "a": "complete_assessment", "v": "10022936", "t": "Complete Assessment" }, { "a": "continue", "v": "10021351", "t": "Continue" }, { "a": "error", "v": "10021353", "t": "An error occurred. Please try again." }, { "a": "personal_info", "v": "10197725", "t": "Personal Information" }, { "a": "responses_saved", "v": "10021886", "t": "Your responses have been saved." }, { "a": "start_assessment", "v": "10171220", "t": "Begin Assessment" }, { "a": "thank_you", "v": "10021365", "t": "Thank you!" } ] }

Last modified: 24 October 2024