Request an assessment questionnaire


Before submitting a profile you will need to request a questionnaire in a language that might be more convenient to your user.


Since the 60 Question profile has assessments on the left and the right, we return the tag <position> to specify where the question needs to be placed for that specific row of the assessment.  However, since the other profile have only 1 statement per row, we always return  <position>L</position>  (left).


If a tagged questionnaire is requested, you will find the following tags in the statements that you want to replace them with the proper values using replacement string commands or regular expressions:


Tag

Replace with

<child>

child's name

<him_her>

him or her

<his_her>

his or her

<himself_herself>

himself or herself



Parameters



Parameter


Value

action

REQUESTQUESTIONNAIRE

token        

{token generated using GENERATETOKEN}

profile

{QT60}

60 questions



{QT15}

15 questions



{QT270}

270 questions



{K360S}

Kids360 - Self assessment



{K360P}

Kids360 - Parent's assessment



{K360T}

Kids360 - Teacher's assessment



{K360R}

Kids360 - Other's assessment



{K360X}

Kids360 - Tagged questionnaire

language

{EN}

English - all profiles supported



{CH}

Simplified Chinese - all profiles supported



{ZA}

Traditional Chinese - QT270



{SW}

Swedish - QT270



{SA}

Arabic - QT270



{ES}

Spanish - QT270



{PO}

Brazilian Portuguese - QT15 / QT60 / QT270

format


JSON / XML





Success Response (Default request)

<response>

       <question>

               <number>

                       [1..60/270]

               </number>

               <position>

                       [L / R]

               </position>

               <statement>

                       [...]

               </statement>

       </question>

</response>



JSON

{  
   "response":{  
      "question":[  
         {  
            "statement":"...",
            "number":"1",
            "position":"L"
         },
         {  
            "statement":"...",
            "number":"1",
            "position":"R"
         },



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.

ERROR103

Wrong profile requested or not authorized to use.  Your account might not have the right to access all the profile. Please the profile code that you have in your contract or, ask us to add the new product to your inventory.

ERROR104

Wrong language requested. Non all reports have translations in other languages. Please refer to  the table above for the list of the supported languages for a given profile. If you need any additional language for a specific profile, please inform us.



Created with the Personal Edition of HelpNDoc: Full-featured EPub generator