Measurements

See protocols for a general description.

Get a single measurement

Sample request

HTTP

HTTP Request

GET /api/v1/measurements/1.json HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_API_TOKEN

cURL

cURL Request

curl "https://api.example.com/api/v1/measurements/1.json" \
  -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/measurements/1.json" `
  -Method GET `
  -Headers $headers

{
  "id": 1,
  "name": "Measurement 0",
  "description": null,
  "active": true,
  "label": "intake",
  "protocol_id": 1,
  "questionnaires": [
    {
      "id": 1,
      "key": "roqua_simple",
      "quby_key": "simple",
      "name": "Simpele Vragenlijst"
    }
  ]
}

Measurement Attributes

Name	Type	Description
id	integer	Id uniquely identifying the measurement.
protocol_id	integer	Id of protocol.
name	string	The name of the measurement, as shown when preparing responses.
description	string	Blob of text what the measurement is for
active	boolean	If false, the protocol doesn’t show up in the interface.
questionnaires	array	array of hashes with basic questionnaires info (see below)

Questionnaire attributes

Name	Type	Description
id	integer	Id uniquely identifying the questionnaire.
key	string	key identifying the questionnaire in roqua, use this one for getting more info on questionnaire.
quby_key	string	Key identifying the actual questionnaire definition (one quby key can be used in multiple roqua questionnaires, but will have exact same questions)
name	string	The name of the questionnaire, as shown when preparing responses.