Application API

The application API exposes several application-specific values:

Name	Value	Explanation	Value type	Notes
name	Application name	The name of the institution as shown to the users.	String	Required, Read-only
mode	Application mode	The mode the application runs in. If this value is null, the application runs in production mode. Other possible values are, but are not limited to, “training”, “beta”, and “development”.	String	Read-only
warning	Application warning	The global warning for users of the application. If this value is null, there is no global warning. Other possible values are, but are not limited to, “for_content_only”, “for_training_only”, “for_testing_only”.	String	Read-only
web_url	Canonical application URL	URL to the application that can be opened in a browser	String	Read-only

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

The following query:

GET /api/2 HTTP/1.1
Host: customer.minddistrict.com
Accept: application/json

The response will be an application response:

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

{
    "@changes": {
        "creation_time": "2021-03-31T06:48:46",
        "modification_time": "2021-03-31T06:48:46"
    },
    "@links": [
        {
            "name": "authenticate",
            "url": "https://customer.minddistrict.com/api/2/authenticate"
        }
    ],
    "@type": "http://ns.minddistrict.com/application",
    "@url": "https://customer.minddistrict.com/api/2",
    "mode": null,
    "name": "Customer application",
    "warning": null,
    "web_url": "https://customer.minddistrict.com"
}

API user

The endpoint’s response contains more or other @links metadata depending on the permission of the current user. For example the API user shows a much complete list of possible discovery links:

The following query:

GET /api/2 HTTP/1.1
Host: customer.minddistrict.com
Accept: application/json
Authorization: md-token gAAAAABgZBtS8Ua9Pcla5dnUix2uJFPm0HT900z-5Y8-zrdwkYL8si-LAOjmPHwF-9ttGIQZ3emBV9IVe2F03-A7M1h0NTO4VrqQxdsKLhkJauBHDSaJk2un3c8_URGlF5EQ0Hu48G6ZVJhWNJum4hA7XLgzwl2kvbsPezsP7QdvWj91n227SGS4nGA-FmNuUhyE2462bOw2

The response will be an application response:

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

{
    "@changes": {
        "creation_time": "2021-03-31T06:48:46",
        "modification_time": "2021-03-31T06:48:46"
    },
    "@links": [
        {
            "name": "authenticate",
            "url": "https://customer.minddistrict.com/api/2/authenticate"
        },
        {
            "name": "catalogue.items",
            "url": "https://customer.minddistrict.com/api/2/catalogue/items"
        },
        {
            "name": "changes",
            "url": "https://customer.minddistrict.com/api/2/changes"
        },
        {
            "name": "configuration.labels",
            "url": "https://customer.minddistrict.com/api/2/configuration/labels"
        },
        {
            "name": "configuration.labels.items",
            "url": "https://customer.minddistrict.com/api/2/configuration/labels/items"
        }
    ],
    "@type": "http://ns.minddistrict.com/application",
    "@url": "https://customer.minddistrict.com/api/2",
    "mode": null,
    "name": "Customer application",
    "warning": null,
    "web_url": "https://customer.minddistrict.com"
}