Get a specific collection

A verified researcher is able to show his collections.

{info} Only a researcher can list his collections

Method Uri Auth Role
GET /v1/collections/{UUID} Bearer JWT-Token researcher

Headers

The API requires a header Accept to be submitted with the request:

{
    "Accept": "application/json",
    "Authorization": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3M..." 
}

Success Responses

Condition : User must be a researcher.

Code : 200 Okay

Content example : Response will reflect back the created requests.

{
    "data": {
        "id": "087016f4-b65c-41f1-972f-20d50bf6c782",
        "name": "Aanvraag",
        "variables": [
            {
                "id": "00b4219c-071c-4f8b-a8ca-8978b7fac2f3",
                "name": "B8_VMS10.4.4.1",
                "label": "Neighbourhoud willing to help",
                "description": "People  in my neighbourhoud are willing to help their neighbors.",
                "category": {
                    "id": "ac02e178-b8f4-4dcc-9188-6f3b4c296e4b",
                    "name": "Neighbourhood solidarity"
                },
                "measured_at": [
                    "Baseline"
                ],
                "value_range": null,
                "value_labels": [
                    "1 = Strongly agree",
                    "2 = Agree",
                    "3 = Neither agree nor disagree",
                    "4 = Disagree",
                    "5 = Strongly disagree",
                    "6 = I dont know"
                ],
                "importance": "Most important variables",
                "calculation": null,
                "keywords": [
                    ""
                ],
                "note": null,
                "additional_info": null,
                "dataset": [
                    "Dataset 2 (N=3451)",
                    "Dataset 3 (N=7689)",
                    "iPRO (N=900)"
                ]
            },
            {
                "id": "002504a8-6e76-4bc2-b36f-27164a811934",
                "name": "HHIEs_Q08",
                "label": "Difficulty listening TV or radio",
                "description": "Does a hearing problem cause you difficulty when listening to TV or radio?",
                "category": {
                    "id": "f6e5aad6-2bd4-47d2-adff-5a95b8a45413",
                    "name": "HHIEs"
                },
                "measured_at": [
                    "Baseline"
                ],
                "value_range": null,
                "value_labels": [
                    "1 = Yes",
                    "2 = Sometimes",
                    "3 = No"
                ],
                "importance": "Most important variables",
                "calculation": null,
                "keywords": [
                    ""
                ],
                "note": null,
                "additional_info": null,
                "dataset": [
                    "Dataset 2 (N=3451)",
                    "Dataset 3 (N=7689)",
                    "iPRO (N=900)"
                ]
            }
        ]
    }
}

Error Responses

Condition : If the current user does not have the role researcher attached.

Code : 403 Unauthorized

Content example :

{
  "message": "User does not have the right roles."
}