Catalogue API

The Minddistrict API publishes a catalogue of content titles. The catalogue currently published the “selfhelp” section.

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.

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

Name

Value

Value type

start

Integer

limit

Integer

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:

GET /api/2/c/cb7bae66c0104b15ac661931811fe365/catalogue/items?content_types=topic&content_types=diary HTTP/1.1
Host: customer.minddistrict.com
Accept: application/json
Authorization: md-token gAAAAABfxfsnijSVf9Tfcer0JhzekIF--SYw4ckwGJXCHGVX6LJAEZkTj6HOs3gGH8OsvcZ4PLSJp-x68spXU3S0xKlEvN5U5ECJx4EdyV7mQUOOhtxfyXfI5wHbL0x3KvizNUMGkFwYgsUvWLMZg7WVvvCuyH_XMlA3LLK4Rvmel0ZRR4CSJ_D1sOCblhrx6Ku3wHmKoeiE

Will trigger this result:

HTTP/1.0 200 Ok
Cache-Control: max-age=0, no-cache, no-store, must-revalidate
Content-Length: 568
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,
            "title": "Topic for docs"
        }
    ],
    "@links": [],
    "@paging": {
        "found": 1,
        "limit": null,
        "start": null,
        "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

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