List collections

Lists a paginated resultset of all researcher's data collections

• Headers
• Query Params
• Success Response

Headers

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

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

Query Params

In case of using different pagination counts than the default (15), add limit to the url parameters.

GET /v1/collections?limit=100&page=4

Success Responses

Condition : All required data provided is valid and added to the request body.

Code : 200 Okay

Content example : Response will reflect back the entities:

{
    "data": [
        {
            "id": "087016f4-b65c-41f1-972f-20d50bf6c782",
            "name": "Aanvraag",
            "writable": true,
            "deletable": false
        },
        {
            "id": "087016f4-b65c-41f1-972f-20d50bf6c781",
            "name": "Banvraag",
            "writable": true,
            "deletable": true
        }
    ],
    "links": {
        "first": "http:\/\/dms.test\/v1\/collections?page=1",
        "last": "http:\/\/dms.test\/v1\/collections?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "http:\/\/dms.test\/v1\/collections?page=1",
                "label": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "http:\/\/dms.test\/v1\/collections",
        "per_page": 15,
        "to": 2,
        "total": 2
    }
}