En español
NIDA

Menu

Developers API

Revised October 2012

Description

To get the the result associated with the token_id. The request will return the score of each sub question. 

URL: <URLBASE>/get_result

Logic

When the user request recieved, the presence and validity of the token_id is checked. If the token_id is a valid one, all the scores of the each sub question is added. 

Sample Request Format

{ 
    "key": "qtye456ceger",
    "token_id" : "556"
}

Params 

token_id required


Method 

(GET|POST)

Sample Response

{
  "status": 1,
  "result": {
    "title": "Substance Involvement Score",
    "scores": [
      {
        "sub_question_id": 10,
        "sub_question_name": "Sedatives or sleeping pills(Valium, Serepax, Ativan, Xanax, Librium, Rohypnol, GHB, etc.)",
        "score": "3.0",
        "level_of_risk": "Lower Risk"
      },
      {
        "sub_question_id": 12,
        "sub_question_name": "Street opioids(heroin, opium, etc.)",
        "score": "28.0",
        "level_of_risk": "High Risk"
      }
    ]
  }
}

Response fields

status Status of the API request
errors Errors if any
messages Messages if any
result Includes a title and an array of scores
scores Each includes a 'sub_question_id', 'sub_question_name', its 'score' and the 'level of risk'

This page was last updated October 2012

Attention

Due to the lapse in government funding, the information on this web site may not be up to date, transactions submitted via the web site may not be processed, and the agency may not be able to respond to inquiries until appropriations are enacted. Updates regarding government operating status and resumption of normal operations can be found at

Looking for Treatment?

Use the SAMHSA Treatment Locator or 1-800-662-HELP.

Helpline open during government shutdown