En español
NIDA

Developers API

This API documentation has been decommissioned and replaced.
See our new Github page for information new tools and APIs available from NIDA. 

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