Questionnaires

Get a single questionnaire

Sample request

HTTP

HTTP Request

GET /api/v1/questionnaires/example HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_API_TOKEN

cURL

cURL Request

curl "https://api.example.com/api/v1/questionnaires/example" \
  -u "username:password"

PowerShell

PowerShell Request

$username = "username"
$password = "password"
$base64AuthInfo = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(("{0}:{1}" -f $username, $password)))

$headers = @{
    "Authorization" = "Basic $base64AuthInfo"
}

Invoke-RestMethod -Uri "https://api.example.com/api/v1/questionnaires/example" `
  -Method GET `
  -Headers $headers

{
  "questionnaire": {
    "id": 116,
    "key": "example",
    "name": "Example",
    "description": "(volwassenen)",
    "short_description": "Health of the Nations Outcome Scales",
    "questions": {
      "v_1": {
        "title": "1. Hoe vaak heeft u last van X?",
        "type": "radio",
        "options": {
          "a1": {
            "value": 0,
            "description": "Nooit"
          },
          "a2": {
            "value": 1,
            "description": "Zelden"
          },
          "a3": {
            "value": 2,
            "description": "Regelmatig"
          },
          "a4": {
            "value": 3,
            "description": "Vaak"
          },
          "a5": {
            "value": 4,
            "description": "Voortdurend"
          },
          "a9": {
            "value": 9,
            "description": "Niet van toepassing"
          }
        }
      },
      "v_2": {
        "title": "2. Hoe vaak heeft u last van Y?",
        "type": "radio",
        "options": {
          "a1": {
            "value": 0,
            "description": "Nooit"
          },
          "a2": {
            "value": 1,
            "description": "Zelden"
          },
          "a3": {
            "value": 2,
            "description": "Regelmatig"
          },
          "a4": {
            "value": 3,
            "description": "Vaak"
          },
          "a5": {
            "value": 4,
            "description": "Voortdurend"
          },
          "a9": {
            "value": 9,
            "description": "Niet van toepassing"
          }
        }
      }
    },
    "scores": {
      "tot": {
        "label": "Somscore"
      },
      "gedr": {
        "label": "Problemen"
      },
      "bep": {
        "label": "Dingen"
      }
    },
    "sbg_info": {
      "sbg_key": "example_sbg_key",
      "questions": {
        "1": "v_1",
        "2": "v_3"
      },
      "scores": {
        "totaalscoreMeting": "to"
      }
    }
  }
}

Query parameters:

parameter	description
use_legacy_keys	(optional, default: true Will change!): Prepend question keys with the questionnaire name instead of v_. - If you want to associate the questionnaire with a response, false is recommended, because the responses endpoint uses v_ prefixes as well. - In the future, use_legacy_keys=false will become default.

Response Attributes

Name	Type	Description
id	integer
key	string
name	string
description	string/null
short_description	string
questions	hash
scores	hash
sbg_info	hash/null	Null if not an sbg questionnaire.

sbg_info

Name	Type	Description
sbg_key	string	The name the SBG gave to the questionnaire.
questions	hash	From sbg identifier to roqua identifier (use_legacy_keys dependent).
scores	hash	From sbg identifier to roqua identifier.