Catalogue API

Main catalogue endpoint

The Minddistrict API publishes a catalogue of content titles. The listed titles can be added as a “tool” to client users using the Tools API. The content titles come with metadata that describe the content’s purpose, audience and use-cases through descriptions and, for example, “poster” images.

The main catalogue endpoint is accessible to professionals and API users. The link to the main catalogue is discoverable through the Application API. It is listed under the name catalogue.items in the @links metadata.

Note

This endpoint requires the use of the limit parameter, to limit the number of items returned for a request. Computing catalogue item responses is relatively expensive and potentially contain a large amount of data. It is highly encouraged to use a fairly low number for the limit parameter. In conjunction with the start parameter you can then request “pages” of results. It is also strongly advised not to request this endpoint with high frequency.

Name

Value

Value type

Notes

start

Integer

limit

Integer

Required
content_types

Content types

List of choice: diary, template treatment, topic, action plan, template rom planning, template screening, template screening intake or template training

Request the titles in the catalogue.:

GET /api/2/catalogue/items?limit=10&start=0 HTTP/1.1
Host: customer.minddistrict.com
Accept: application/json
Authorization: md-token gAAAAABgZBtS8Ua9Pcla5dnUix2uJFPm0HT900z-5Y8-zrdwkYL8si-LAOjmPHwF-9ttGIQZ3emBV9IVe2F03-A7M1h0NTO4VrqQxdsKLhkJauBHDSaJk2un3c8_URGlF5EQ0Hu48G6ZVJhWNJum4hA7XLgzwl2kvbsPezsP7QdvWj91n227SGS4nGA-FmNuUhyE2462bOw2

Will trigger this result:

HTTP/1.0 200 Ok
Cache-Control: max-age=0, no-cache, no-store, must-revalidate
Content-Length: 2922
Content-Type: application/json;charset=UTF-8

{
    "@items": [
        {
            "@type": "http://ns.minddistrict.com/catalogue/item",
            "content_type": "template treatment",
            "description": null,
            "id": "tre_4862410a_c4ba_4cd9_9283_caaa62bfa260",
            "lang": "nl",
            "poster": null,
            "short_description": null,
            "subtitle": null,
            "suitable_for_selfhelp": false,
            "title": "ADHD"
        },
        {
            "@type": "http://ns.minddistrict.com/catalogue/item",
            "content_type": "diary",
            "description": null,
            "id": "df67233c8dd247efaa3b071685de8dad",
            "lang": "nl",
            "poster": "https://cs.minddistrict.com/df67233c8dd247efaa3b071685de8dad/20/resources/5_omgaan_met_gevoelens_poster.png",
            "short_description": "Met het dagboek 'Emotie' houd je bij hoe je gevoel op een bepaald moment was. Je kunt je gevoel ook toelichten met behulp van tekst of een foto. Je kunt je gevoel per dag volgen in een grafiek. Zo krijg je meer inzicht in je gevoel.",
            "subtitle": "Bijhouden van je emoties",
            "suitable_for_selfhelp": true,
            "title": "Emoties"
        },
        {
            "@type": "http://ns.minddistrict.com/catalogue/item",
            "content_type": "diary",
            "description": "<p>Dit dagboek is ontwikkeld op basis van de oefening 'Inchecken'\u00a0van de ACT-module. In het dagboek kunnen cli\u00ebnten meerdere malen per dag op een makkelijke manier bij zichzelf nagaan hoe het met ze gaat. Ze staan stil bij gedachten, emoties, lichamelijke sensaties, energieniveau en gedrag. De informatie kunnen ze gebruiken om hun dag verder vorm te geven. Gaat het goed, dan hoeft er niets veranderd te worden. Gaat het minder goed, dan is er aanpassing nodig.</p>",
            "id": "9755e3b8e5194b8eb329d9c4b5970fb7",
            "lang": "nl",
            "poster": "https://cs.minddistrict.com/9755e3b8e5194b8eb329d9c4b5970fb7/4/resources/8_dagboek_leven_op_orde.png",
            "short_description": "Dit dagboek is onderdeel van de ACT-module van Klacht naar Veerkracht. Een client kan het gebruiken om dagelijks 'in te checken' bij zichzelf.",
            "subtitle": null,
            "suitable_for_selfhelp": false,
            "title": "Inchecken"
        },
        {
            "@type": "http://ns.minddistrict.com/catalogue/item",
            "content_type": "topic",
            "description": null,
            "id": "docs_topic",
            "lang": "nl",
            "poster": "https://cs.minddistrict.com/docs_topic/11/resources/vis_poster.png",
            "short_description": null,
            "subtitle": null,
            "suitable_for_selfhelp": true,
            "title": "Topic for docs"
        }
    ],
    "@links": [],
    "@paging": {
        "found": 4,
        "limit": 10,
        "start": 0,
        "total": null
    }
}

The items in the catalogue have the following properties:

Name

Value

Value type

Notes

id

Internal id

String

Required
content_type

Content type

Choice: diary, document, reusable pages, template rom entry, template rom planning, template screening, template screening intake, template screening signup, template training, template treatment or topic

Required
lang

Language

Choice: da, de, en, es, fr, hu or nl

Required
title

Title

String

Required
subtitle

Subtitle

String

description

Description

HTML string

short_description

Short description

String

poster

Poster image

URL

suitable_for_selfhelp

Suitable for self-help

Boolean

The @type meta information for this object is: http://ns.minddistrict.com/catalogue/item.

Use the content_types parameters to constrain the content types returned by the catalogue endpoint:

Request the titles in the catalogue, restricted to the “topic” content type.:

GET /api/2/catalogue/items?limit=10&start=0&content_types=topic HTTP/1.1
Host: customer.minddistrict.com
Accept: application/json
Authorization: md-token gAAAAABgZBtS8Ua9Pcla5dnUix2uJFPm0HT900z-5Y8-zrdwkYL8si-LAOjmPHwF-9ttGIQZ3emBV9IVe2F03-A7M1h0NTO4VrqQxdsKLhkJauBHDSaJk2un3c8_URGlF5EQ0Hu48G6ZVJhWNJum4hA7XLgzwl2kvbsPezsP7QdvWj91n227SGS4nGA-FmNuUhyE2462bOw2

Will trigger this result:

HTTP/1.0 200 Ok
Cache-Control: max-age=0, no-cache, no-store, must-revalidate
Content-Length: 606
Content-Type: application/json;charset=UTF-8

{
    "@items": [
        {
            "@type": "http://ns.minddistrict.com/catalogue/item",
            "content_type": "topic",
            "description": null,
            "id": "docs_topic",
            "lang": "nl",
            "poster": "https://cs.minddistrict.com/docs_topic/11/resources/vis_poster.png",
            "short_description": null,
            "subtitle": null,
            "suitable_for_selfhelp": true,
            "title": "Topic for docs"
        }
    ],
    "@links": [],
    "@paging": {
        "found": 1,
        "limit": 10,
        "start": 0,
        "total": null
    }
}

Content types

The different content types map to the different types of modules or tools in the Minddistrict platform:

Content type

Used for

topic

Module (a.k.a. “mobile module”) content

diary

Dairy schema definition content

template treatment

Legacy module content

template training

Legacy training content

template screening

Legacy screening content

template screening intake

Legacy intake screening content

template rom planning

Legacy monitoring planning template

Self-help catalogue endpoint

Client accounts also publish a catalogue endpoint. The main use case is clients can list the catalogue items suitable for self-help. If this endpoint is accessed by the therapist or API users, the result will be the full list of available catalogue itens.

To view the list of entries for a specific catalogue section send a GET request to the catalogue.selfhelp.items URL. This URL is discoverable in the @links metadata of a client or a friend under the name catalogue.selfhelp.items.

Note

This endpoint requires the use of the limit parameter, to limit the number of items returned for a request. Computing catalogue item responses is relatively expensive and potentially contain a large amount of data. It is highly encouraged to use a fairly low number for the limit parameter. In conjunction with the start parameter you can then request “pages” of results. It is also strongly advised not to request this endpoint with high frequency.

Name

Value

Value type

Notes

start

Integer

limit

Integer

Required
content_types

Content types

List of choice: diary, template treatment, topic, action plan, template rom planning, template screening, template screening intake or template training

Request the titles in the selfhelp catalogue as requested by the client itself. This restricts the result to only show self-help catalogue items.:

GET /api/2/c/c4a1446b21674c82b9cde931b5be1b3e/catalogue/items?limit=10&start=0 HTTP/1.1
Host: customer.minddistrict.com
Accept: application/json
Authorization: md-token gAAAAABgZBtPqrhCCvMZaP5HjMI5pXMVZ-Pf1novgNpTI3KU9MDy1NMs2Mo-CPhtMsXMA89_qJjCwSKXBcjXdjmbmYfNIMKkYgxEogXwgsrV4wCERvWwNqdDcpuUfwAh9Y9y9Ogt2qtfuWFZQuDpMNImXc_ftlL1VMnTjUIeWThHCfYdy083adrmcQcZOmNzDFykyt-iRcMl

Will trigger this result:

HTTP/1.0 200 Ok
Cache-Control: max-age=0, no-cache, no-store, must-revalidate
Content-Length: 1371
Content-Type: application/json;charset=UTF-8

{
    "@items": [
        {
            "@type": "http://ns.minddistrict.com/catalogue/item",
            "content_type": "diary",
            "description": null,
            "id": "df67233c8dd247efaa3b071685de8dad",
            "lang": "nl",
            "poster": "https://cs.minddistrict.com/df67233c8dd247efaa3b071685de8dad/20/resources/5_omgaan_met_gevoelens_poster.png",
            "short_description": "Met het dagboek 'Emotie' houd je bij hoe je gevoel op een bepaald moment was. Je kunt je gevoel ook toelichten met behulp van tekst of een foto. Je kunt je gevoel per dag volgen in een grafiek. Zo krijg je meer inzicht in je gevoel.",
            "subtitle": "Bijhouden van je emoties",
            "suitable_for_selfhelp": true,
            "title": "Emoties"
        },
        {
            "@type": "http://ns.minddistrict.com/catalogue/item",
            "content_type": "topic",
            "description": null,
            "id": "docs_topic",
            "lang": "nl",
            "poster": "https://cs.minddistrict.com/docs_topic/11/resources/vis_poster.png",
            "short_description": null,
            "subtitle": null,
            "suitable_for_selfhelp": true,
            "title": "Topic for docs"
        }
    ],
    "@links": [],
    "@paging": {
        "found": 2,
        "limit": 10,
        "start": 0,
        "total": null
    }
}

Request the titles in the selfhelp catalogue as requested by the API users. This results in all catalogue items being listed.:

GET /api/2/c/c4a1446b21674c82b9cde931b5be1b3e/catalogue/items?limit=10&start=0 HTTP/1.1
Host: customer.minddistrict.com
Accept: application/json
Authorization: md-token gAAAAABgZBtS8Ua9Pcla5dnUix2uJFPm0HT900z-5Y8-zrdwkYL8si-LAOjmPHwF-9ttGIQZ3emBV9IVe2F03-A7M1h0NTO4VrqQxdsKLhkJauBHDSaJk2un3c8_URGlF5EQ0Hu48G6ZVJhWNJum4hA7XLgzwl2kvbsPezsP7QdvWj91n227SGS4nGA-FmNuUhyE2462bOw2

Will trigger this result:

HTTP/1.0 200 Ok
Cache-Control: max-age=0, no-cache, no-store, must-revalidate
Content-Length: 2922
Content-Type: application/json;charset=UTF-8

{
    "@items": [
        {
            "@type": "http://ns.minddistrict.com/catalogue/item",
            "content_type": "template treatment",
            "description": null,
            "id": "tre_4862410a_c4ba_4cd9_9283_caaa62bfa260",
            "lang": "nl",
            "poster": null,
            "short_description": null,
            "subtitle": null,
            "suitable_for_selfhelp": false,
            "title": "ADHD"
        },
        {
            "@type": "http://ns.minddistrict.com/catalogue/item",
            "content_type": "diary",
            "description": null,
            "id": "df67233c8dd247efaa3b071685de8dad",
            "lang": "nl",
            "poster": "https://cs.minddistrict.com/df67233c8dd247efaa3b071685de8dad/20/resources/5_omgaan_met_gevoelens_poster.png",
            "short_description": "Met het dagboek 'Emotie' houd je bij hoe je gevoel op een bepaald moment was. Je kunt je gevoel ook toelichten met behulp van tekst of een foto. Je kunt je gevoel per dag volgen in een grafiek. Zo krijg je meer inzicht in je gevoel.",
            "subtitle": "Bijhouden van je emoties",
            "suitable_for_selfhelp": true,
            "title": "Emoties"
        },
        {
            "@type": "http://ns.minddistrict.com/catalogue/item",
            "content_type": "diary",
            "description": "<p>Dit dagboek is ontwikkeld op basis van de oefening 'Inchecken'\u00a0van de ACT-module. In het dagboek kunnen cli\u00ebnten meerdere malen per dag op een makkelijke manier bij zichzelf nagaan hoe het met ze gaat. Ze staan stil bij gedachten, emoties, lichamelijke sensaties, energieniveau en gedrag. De informatie kunnen ze gebruiken om hun dag verder vorm te geven. Gaat het goed, dan hoeft er niets veranderd te worden. Gaat het minder goed, dan is er aanpassing nodig.</p>",
            "id": "9755e3b8e5194b8eb329d9c4b5970fb7",
            "lang": "nl",
            "poster": "https://cs.minddistrict.com/9755e3b8e5194b8eb329d9c4b5970fb7/4/resources/8_dagboek_leven_op_orde.png",
            "short_description": "Dit dagboek is onderdeel van de ACT-module van Klacht naar Veerkracht. Een client kan het gebruiken om dagelijks 'in te checken' bij zichzelf.",
            "subtitle": null,
            "suitable_for_selfhelp": false,
            "title": "Inchecken"
        },
        {
            "@type": "http://ns.minddistrict.com/catalogue/item",
            "content_type": "topic",
            "description": null,
            "id": "docs_topic",
            "lang": "nl",
            "poster": "https://cs.minddistrict.com/docs_topic/11/resources/vis_poster.png",
            "short_description": null,
            "subtitle": null,
            "suitable_for_selfhelp": true,
            "title": "Topic for docs"
        }
    ],
    "@links": [],
    "@paging": {
        "found": 4,
        "limit": 10,
        "start": 0,
        "total": null
    }
}

Also for this endpoint, use the content_types parameters to constrain the content types returned by the catalogue endpoint:

Request the titles in the catalogue, restricted to the “topic” content type.:

GET /api/2/c/c4a1446b21674c82b9cde931b5be1b3e/catalogue/items?limit=10&start=0&content_types=topic HTTP/1.1
Host: customer.minddistrict.com
Accept: application/json
Authorization: md-token gAAAAABgZBtS8Ua9Pcla5dnUix2uJFPm0HT900z-5Y8-zrdwkYL8si-LAOjmPHwF-9ttGIQZ3emBV9IVe2F03-A7M1h0NTO4VrqQxdsKLhkJauBHDSaJk2un3c8_URGlF5EQ0Hu48G6ZVJhWNJum4hA7XLgzwl2kvbsPezsP7QdvWj91n227SGS4nGA-FmNuUhyE2462bOw2

Will trigger this result:

HTTP/1.0 200 Ok
Cache-Control: max-age=0, no-cache, no-store, must-revalidate
Content-Length: 606
Content-Type: application/json;charset=UTF-8

{
    "@items": [
        {
            "@type": "http://ns.minddistrict.com/catalogue/item",
            "content_type": "topic",
            "description": null,
            "id": "docs_topic",
            "lang": "nl",
            "poster": "https://cs.minddistrict.com/docs_topic/11/resources/vis_poster.png",
            "short_description": null,
            "subtitle": null,
            "suitable_for_selfhelp": true,
            "title": "Topic for docs"
        }
    ],
    "@links": [],
    "@paging": {
        "found": 1,
        "limit": 10,
        "start": 0,
        "total": null
    }
}