SUBMITPROFILE
|
submit personality assessment |
When you submit the personality assessment you will be passing over also the user data. While all the field are required for the API call to succeed, please use discretionary data in order to abide to PDPA or GDPR policies.
To prevent errors do filter any apostrophe sign that the user might have in the name of in any other data field. If you are trying to pass non UTF8 characters, perse do convert them into Unicode HTML first or they will be wrongly printed on the PDF report.
Parameters
Parameter |
Value |
||
action |
|
SUBMITPROFILE |
|
token |
|
||
userLogin |
|
{the ID generated using GENERATEUSERID} |
|
userPassword |
|
{the password generated using GENERATEUSERID} |
|
userFullName |
|
the full name of the user. It will be used on the PDF reports |
|
userAge |
|
{0 to 99} |
user's age |
userGender |
|
{M / F/ X} |
user's gender |
userEmail |
|
{a valid email address} |
|
userDesignation |
|
{any value} |
|
profile |
|
{QT60} |
60 questions |
{QT15} |
15 questions |
||
{QT270} |
270 questions |
||
{K360S/P/R/T} |
any of the Kids360 assessment |
||
T1 ~ T60 |
|
{1/2/3/4/5} |
answersheet fields for the QT60 |
T1 ~ T270 |
|
{1/2/3/4/5} |
answersheet fields for the QT270 for the K360S/P/T/R |
format |
JSON / XML |
||
Success Response (Default)
{UserLogin}:OK |
|
JSON
{ "SUBMIT": "OK" } |
|
Errors
Code |
Description |
ERROR101 |
The token used is not in the database (request a new token) |
ERROR102 |
Token IP does not macth the requesting IP -The token is an existing token but the IP that issued the API call is not the one the token was authorized to use. Please inform us about the IP change, if your server has a new IP or, issue calls from the right IP address. |
ERROR201 |
The user ID specified in the API call was not found in the database |
ERROR202 |
The user ID specified in the API call does not belong to your company |
ERROR203 |
The userFullName field was either empty or was not passed in the API call |
ERROR204 |
the userAge field has a value that is either non numerical or was not in the range between 0 to 99 |
ERROR205 |
the userGender value is not correct. Please use "M"/"F" or use "X" in any other instance or whenever you cannot specify any other value |
ERROR206 |
(no longer used) |
ERROR207 |
the userEmail does not hold a correct value. In case you do not have an email address or if your user does not authorize the retrasmission of the email address, for that user please use a dummy value such as "a@a.com" |
ERROR208 |
the userDesignation field was left empty. This can be any descriptive value that you might want to use later on in order to filter and categorize your data. |
ERROR209 |
the profile parameter does not hold a correct value. Please refer to the table above to use the correct value for this parameter. |
ERROR210 |
a profile submission for this user id is already existing in the database |
ERROR211 |
a profile cannot be submitted for this user (likely already submitted or wrong id) - no association user / product to submit found |
ERROR212 |
a profile cannot be submitted because the profile submitted is not the profile that was associated to the user id when created |
ERROR3001 to ERROR3270 |
each error is associated to a an answersheet field (eg.: ERROR3001 is associated with the field T1, ERROR30002 associated to T2 and so on so forth). this error is returned when the related answersheet field is either wrong or it was not passed through during the API call. |
Created with the Personal Edition of HelpNDoc: Easily create Qt Help files