Client API¶

The Minddistrict API to access and modify client data is accessible under the sub-URL /c of the API. In addition to the basic user account API, the Client API provides:

Client JSON object
Listing clients
Clients search API
Adding a new client
View a client
Editing a client
Activating a client
Merging clients
Client/professional relations
Client access log
- Log record JSON object

Client JSON object ¶

Information about clients in the Minddistrict API is transferred as json objects containing the following information:

Name	Value	Explanation	Value type	Notes
`first_name`	First name	-	String	Required
`infix`	Infix	-	String
`last_name`	Last name	-	String	Required
`active`	Active	Uncheck to deactivate the user acount. The user can not log in to the platform as long as the account is inactive.	Boolean	Required
`external_source`	External source of information	Name of the external information source or API user identifier. Can be empty. Should not be set by users nor API interaction. Based on this value and the corresponding configuration setting manual updates can be disallowed.	String	Read-only
`email`	Email address	The email address is used as login name for the platform. It should be unique in the platform. It may not contain uppercase characters.	String	Required
`picture`	Profile picture	You can upload a profile picture.	File	Setting-dependent
`labels`	Labels	Clients don’t see which labels are assigned to them.	List of labels	Setting-dependent
`age`	Age	-	Integer	Required, Read-only
`gender`	Gender	-	Choice: `m`, `f`, `other` or `unknown`	Required
`date_of_birth`	Date of birth	-	Date	Required, Setting-dependent
`phone_number`	Telephone number	-	String	Setting-dependent
`id`	Client ID	ID of the client, should be unique in the platform.	String	Setting-dependent
`bsn`	BSN	BSN of the client, should be unique in the platform.	String	Setting-dependent
`name`	Name	-	String	Required, Read-only

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

Note

Depening on per-platform configuration, some fields are not available. Or, if made available they can be set to required as well. The presence of fields in the object serialization and what fields and values are allowed in the add and modification requests follow the platform’s configuration.

In other words, the examples below may contain not all fields that a specific platform enabled or requires or may contain fields that have been disabled in a certain platform configuration.

Notable examples of such fields are id, bsn, and telephone number fields.

Listing clients ¶

To get a list of all client objects send a GET request to the API base URL with c/items appended:

GET /api/2/c/items HTTP/1.1
Host: customer.minddistrict.com
Accept: application/json
Authorization: md-token gAAAAABgkqXDwiLOxI5oI6FsRrKlwJE9Tlle3bPvWUhL15M61j4A-yYqMfouc69ELhIvymLeIxjOk_SZqIZMapGgKyrYUzu-os9Vp7mVL2KlBjwMeuX0hJMx_1CjyMmsfzx4RitIM3b5KVpYfI3YWF97cHPEY1POYdUdxTHPH0IOzJggptPk3d6L6EF1jxZEieJCC9TdywYX

The response will be a list of client objects and friend objects:

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

{
    "@items": [
        {
            "@changes": {
                "creation_time": "2021-05-05T14:03:45",
                "modification_time": "2021-05-05T14:03:48"
            },
            "@type": "http://ns.minddistrict.com/client",
            "@url": "https://customer.minddistrict.com/api/2/c/a42d2968cb9c4186a8449b1d02117e12",
            "active": true,
            "age": 51,
            "date_of_birth": "1970-01-01",
            "email": "wendy@example.com",
            "external_source": null,
            "first_name": "Wendy",
            "gender": "f",
            "infix": "",
            "labels": [
                "be6e40f0-a3b4-486b-a1c7-f9b97b483b00"
            ],
            "last_name": "Darling",
            "name": "Wendy Darling",
            "picture": {
                "@type": "link",
                "content_type": "image/jpeg",
                "filename": "../../fixtures/profile.jpg",
                "size": 4488,
                "url": "https://customer.minddistrict.com/api/2/c/a42d2968cb9c4186a8449b1d02117e12/preferences/picture/picture/8937d1d392284b3aa62a11a32f62c8ca"
            }
        },
        {
            "@changes": {
                "creation_time": "2021-05-05T14:03:46",
                "modification_time": "2021-05-05T14:03:46"
            },
            "@type": "http://ns.minddistrict.com/friend",
            "@url": "https://customer.minddistrict.com/api/2/c/14aea4d0a3764d0c8bcb8d921b097b34",
            "active": true
        },
        {
            "@changes": {
                "creation_time": "2021-05-05T14:03:46",
                "modification_time": "2021-05-05T14:03:46"
            },
            "@type": "http://ns.minddistrict.com/client",
            "@url": "https://customer.minddistrict.com/api/2/c/64c15d5c6bec437293561d399c11c67f",
            "active": true,
            "age": 51,
            "date_of_birth": "1970-01-01",
            "email": "michael@example.com",
            "external_source": null,
            "first_name": "Micha\u00ebl",
            "gender": "m",
            "infix": "",
            "labels": null,
            "last_name": "Darling",
            "name": "Micha\u00ebl Darling",
            "picture": null
        },
        {
            "@changes": {
                "creation_time": "2021-05-05T14:03:46",
                "modification_time": "2021-05-05T14:03:46"
            },
            "@type": "http://ns.minddistrict.com/client",
            "@url": "https://customer.minddistrict.com/api/2/c/b698d76574fe4eb082ef75c7c8306dd9",
            "active": true,
            "age": 51,
            "date_of_birth": "1970-01-01",
            "email": "gwendoline@example.com",
            "external_source": null,
            "first_name": "Gwendoline",
            "gender": "f",
            "infix": "",
            "labels": null,
            "last_name": "Darling",
            "name": "Gwendoline Darling",
            "picture": null
        }
    ],
    "@links": [],
    "@paging": {
        "found": 4,
        "limit": null,
        "start": null,
        "total": null
    }
}

Clients search API ¶

A simple search API is available on the client items endpoint. To search send a POST request to the API base URL with c/items appended. Put the JSON encoded search query parameters in the body of the request:

POST /api/2/c/items HTTP/1.1
Host: customer.minddistrict.com
Accept: application/json
Authorization: md-token gAAAAABgkqXDwiLOxI5oI6FsRrKlwJE9Tlle3bPvWUhL15M61j4A-yYqMfouc69ELhIvymLeIxjOk_SZqIZMapGgKyrYUzu-os9Vp7mVL2KlBjwMeuX0hJMx_1CjyMmsfzx4RitIM3b5KVpYfI3YWF97cHPEY1POYdUdxTHPH0IOzJggptPk3d6L6EF1jxZEieJCC9TdywYX
Content-Length: 41
Content-Type: application/json

{
    "email": "gwendoline@example.com"
}

The response will be a list of client objects:

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

{
    "@items": [
        {
            "@changes": {
                "creation_time": "2021-05-05T14:03:46",
                "modification_time": "2021-05-05T14:03:46"
            },
            "@type": "http://ns.minddistrict.com/client",
            "@url": "https://customer.minddistrict.com/api/2/c/b698d76574fe4eb082ef75c7c8306dd9",
            "active": true,
            "age": 51,
            "date_of_birth": "1970-01-01",
            "email": "gwendoline@example.com",
            "external_source": null,
            "first_name": "Gwendoline",
            "gender": "f",
            "infix": "",
            "labels": null,
            "last_name": "Darling",
            "name": "Gwendoline Darling",
            "picture": null
        }
    ],
    "@links": [],
    "@paging": {
        "found": 1,
        "limit": null,
        "start": null,
        "total": null
    }
}

The allowed parameters are listed below. All parameters are optional.

Name	Value	Value type
`start`		Integer
`limit`		Integer
`active`	active	Boolean
`bsn`	bsn	String
`email`	email	String
`id`	client id	String

Multiple parameters will be “AND”ed together. Currently you cannot search for items that have no value set for given parameter. This might change in at a later stage.

Adding a new client ¶

To add a client send a POST request to the API base URL with /c appended. Put the JSON encoded data for the new client in the body of the request:

POST /api/2/c HTTP/1.1
Host: customer.minddistrict.com
Accept: application/json
Authorization: md-token gAAAAABgkqXDwiLOxI5oI6FsRrKlwJE9Tlle3bPvWUhL15M61j4A-yYqMfouc69ELhIvymLeIxjOk_SZqIZMapGgKyrYUzu-os9Vp7mVL2KlBjwMeuX0hJMx_1CjyMmsfzx4RitIM3b5KVpYfI3YWF97cHPEY1POYdUdxTHPH0IOzJggptPk3d6L6EF1jxZEieJCC9TdywYX
Content-Length: 164
Content-Type: application/json

{
    "active": false,
    "date_of_birth": "1961-02-18",
    "email": "john@example.com",
    "first_name": "John",
    "gender": "m",
    "last_name": "Darling"
}

The response will return the newly created client object:

HTTP/1.0 201 Created
Cache-Control: max-age=0, no-cache, no-store, must-revalidate
Content-Length: 588
Content-Type: application/json;charset=UTF-8
Location: https://customer.minddistrict.com/api/2/c/6f9f86353f6943878c194318102f7483

{
    "@changes": {
        "creation_time": "2021-05-05T14:03:51",
        "modification_time": "2021-05-05T14:03:51"
    },
    "@type": "http://ns.minddistrict.com/client",
    "@url": "https://customer.minddistrict.com/api/2/c/6f9f86353f6943878c194318102f7483",
    "active": false,
    "age": 60,
    "date_of_birth": "1961-02-18",
    "email": "john@example.com",
    "external_source": "de5e962094e04f708e92b83cf9e2f304",
    "first_name": "John",
    "gender": "m",
    "infix": "",
    "labels": null,
    "last_name": "Darling",
    "name": "John Darling",
    "picture": null
}

If the active flag was set to true, a welcome email will be sent to the client. If the flag was false, no email will be sent and the client will not be able to access the Minddistrict platform.

View a client ¶

To view a client send a GET request to the URL of the client:

GET /api/2/c/a42d2968cb9c4186a8449b1d02117e12 HTTP/1.1
Host: customer.minddistrict.com
Accept: application/json
Authorization: md-token gAAAAABgkqXDwiLOxI5oI6FsRrKlwJE9Tlle3bPvWUhL15M61j4A-yYqMfouc69ELhIvymLeIxjOk_SZqIZMapGgKyrYUzu-os9Vp7mVL2KlBjwMeuX0hJMx_1CjyMmsfzx4RitIM3b5KVpYfI3YWF97cHPEY1POYdUdxTHPH0IOzJggptPk3d6L6EF1jxZEieJCC9TdywYX

The response will be the corresponding client object:

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

{
    "@changes": {
        "creation_time": "2021-05-05T14:03:45",
        "modification_time": "2021-05-05T14:03:48"
    },
    "@links": [
        {
            "name": "activation",
            "url": "https://customer.minddistrict.com/api/2/c/a42d2968cb9c4186a8449b1d02117e12/activation"
        },
        {
            "name": "application",
            "url": "https://customer.minddistrict.com/api/2"
        },
        {
            "name": "catalogue.selfhelp.items",
            "url": "https://customer.minddistrict.com/api/2/c/a42d2968cb9c4186a8449b1d02117e12/catalogue/items"
        },
        {
            "name": "conversations",
            "url": "https://customer.minddistrict.com/api/2/c/a42d2968cb9c4186a8449b1d02117e12/conversations"
        },
        {
            "name": "planning",
            "url": "https://customer.minddistrict.com/api/2/c/a42d2968cb9c4186a8449b1d02117e12/planning"
        },
        {
            "name": "planning.ics",
            "url": "https://customer.minddistrict.com/api/2/c/a42d2968cb9c4186a8449b1d02117e12/planning/ics"
        },
        {
            "name": "planning.items",
            "url": "https://customer.minddistrict.com/api/2/c/a42d2968cb9c4186a8449b1d02117e12/planning/items"
        },
        {
            "name": "relations",
            "url": "https://customer.minddistrict.com/api/2/c/a42d2968cb9c4186a8449b1d02117e12/relations"
        },
        {
            "name": "relations.items",
            "url": "https://customer.minddistrict.com/api/2/c/a42d2968cb9c4186a8449b1d02117e12/relations/items"
        },
        {
            "name": "tasks",
            "url": "https://customer.minddistrict.com/api/2/c/a42d2968cb9c4186a8449b1d02117e12/tasks"
        },
        {
            "name": "tasks.items",
            "url": "https://customer.minddistrict.com/api/2/c/a42d2968cb9c4186a8449b1d02117e12/tasks/items"
        },
        {
            "name": "tools",
            "url": "https://customer.minddistrict.com/api/2/c/a42d2968cb9c4186a8449b1d02117e12/tools"
        }
    ],
    "@type": "http://ns.minddistrict.com/client",
    "@url": "https://customer.minddistrict.com/api/2/c/a42d2968cb9c4186a8449b1d02117e12",
    "active": true,
    "age": 51,
    "date_of_birth": "1970-01-01",
    "email": "wendy@example.com",
    "external_source": null,
    "first_name": "Wendy",
    "gender": "f",
    "infix": "",
    "labels": [
        "be6e40f0-a3b4-486b-a1c7-f9b97b483b00"
    ],
    "last_name": "Darling",
    "name": "Wendy Darling",
    "picture": {
        "@type": "link",
        "content_type": "image/jpeg",
        "filename": "../../fixtures/profile.jpg",
        "size": 4488,
        "url": "https://customer.minddistrict.com/api/2/c/a42d2968cb9c4186a8449b1d02117e12/preferences/picture/picture/8937d1d392284b3aa62a11a32f62c8ca"
    }
}

This endpoint is also reachable via auxiliary URLs.

Editing a client ¶

To modify client data send a PATCH request to the URL of the client with the modification contained in the body:

PATCH /api/2/c/a42d2968cb9c4186a8449b1d02117e12 HTTP/1.1
Host: customer.minddistrict.com
Accept: application/json
Authorization: md-token gAAAAABgkqXDwiLOxI5oI6FsRrKlwJE9Tlle3bPvWUhL15M61j4A-yYqMfouc69ELhIvymLeIxjOk_SZqIZMapGgKyrYUzu-os9Vp7mVL2KlBjwMeuX0hJMx_1CjyMmsfzx4RitIM3b5KVpYfI3YWF97cHPEY1POYdUdxTHPH0IOzJggptPk3d6L6EF1jxZEieJCC9TdywYX
Content-Length: 29
Content-Type: application/json

{
    "first_name": "James"
}

Please refer to Activating a client to change the active flag of a client.

This endpoint is also reachable via auxiliary URLs.

Activating a client ¶

To activate or deactivate a client send a POST request to the URL of the client with /activation appended. Insert a JSON object in the body of the request with the relevant attributes:

POST /api/2/c/a42d2968cb9c4186a8449b1d02117e12/activation HTTP/1.1
Host: customer.minddistrict.com
Accept: application/json
Authorization: md-token gAAAAABgkqXDwiLOxI5oI6FsRrKlwJE9Tlle3bPvWUhL15M61j4A-yYqMfouc69ELhIvymLeIxjOk_SZqIZMapGgKyrYUzu-os9Vp7mVL2KlBjwMeuX0hJMx_1CjyMmsfzx4RitIM3b5KVpYfI3YWF97cHPEY1POYdUdxTHPH0IOzJggptPk3d6L6EF1jxZEieJCC9TdywYX
Content-Length: 23
Content-Type: application/json

{
    "active": false
}

When activating a client the parameter send_email controls whether and what kind of email will be sent. For a value of no no email is sent. For a value of welcome a welcome email is sent: this is the same email a client gets when they are added to the platform for the first time. For a value of activation an email will be sent that simply tells the client that their account has been activated.:

POST /api/2/c/a42d2968cb9c4186a8449b1d02117e12/activation HTTP/1.1
Host: customer.minddistrict.com
Accept: application/json
Authorization: md-token gAAAAABgkqXDwiLOxI5oI6FsRrKlwJE9Tlle3bPvWUhL15M61j4A-yYqMfouc69ELhIvymLeIxjOk_SZqIZMapGgKyrYUzu-os9Vp7mVL2KlBjwMeuX0hJMx_1CjyMmsfzx4RitIM3b5KVpYfI3YWF97cHPEY1POYdUdxTHPH0IOzJggptPk3d6L6EF1jxZEieJCC9TdywYX
Content-Length: 51
Content-Type: application/json

{
    "active": true,
    "send_email": "welcome"
}

The activation endpoint accepts the following parameters in the body of its request:

Name	Value	Value type	Notes
`active`	active	Boolean	Required
`send_email`	Type of (de)activation message.	Choice: `activation`, `welcome` or `no`

When deactivating a client by default an email is sent to the client informing them of the deactivation. When the send_email parameter is passed with a value of no such an email is not sent.:

POST /api/2/c/a42d2968cb9c4186a8449b1d02117e12/activation HTTP/1.1
Host: customer.minddistrict.com
Accept: application/json
Authorization: md-token gAAAAABgkqXDwiLOxI5oI6FsRrKlwJE9Tlle3bPvWUhL15M61j4A-yYqMfouc69ELhIvymLeIxjOk_SZqIZMapGgKyrYUzu-os9Vp7mVL2KlBjwMeuX0hJMx_1CjyMmsfzx4RitIM3b5KVpYfI3YWF97cHPEY1POYdUdxTHPH0IOzJggptPk3d6L6EF1jxZEieJCC9TdywYX
Content-Length: 47
Content-Type: application/json

{
    "active": false,
    "send_email": "no"
}

When a request is sent to activate a client who is already active, nothing happens, and the response has a 400 (error) status code. An email is also not sent.

When a request is sent to deactivate a client who is already inactive, nothing happens, and the response has a 400 (error) status code. An email is also not sent.

Merging clients ¶

To merge one client into another send a POST request to the URL of the client you want to keep with /merge appended. The body of the request should be a client reference (given by either the id or canonical URL) to the client you want to have merged into the first client:

POST /api/2/c/a42d2968cb9c4186a8449b1d02117e12/merge HTTP/1.1
Host: customer.minddistrict.com
Accept: application/json
Authorization: md-token gAAAAABgkqXG2bS_PiXpMdWVH-duyToJ9j7sappe7M3qGCRjdWC-vfZq2JWWGgcQQCIyeVlhrPp_W2GEeGqOStRZYELc4gpBLa0m2idCuHhxzo6EPLm4aJvdj5NCvWPnTnW_jCDA4nsSHv4goVfWjCZzHAnFCCqjxaLhvSc0Fr5qz1rpPrWXKEjFC6PDopIlAQ7AdixeFymP
Content-Length: 22
Content-Type: application/json

{
    "id": "123abc"
}

The client whose id or url is passed in will be completely merged into the client whose URL the request is sent to. All the tools will be transferred to the latter and that client will be the only one remaining.

Client/professional relations ¶

The Client Relations API allows you to manage the relations a client has with various professionals. This has multiple effects within the Minddistrict platform; in particular privacy-sensitive information about a client is generally only visible to related professionals, and related professionals may get assigned tasks specific to that client.

A professional can have two types of relations with a client: attends and supervises. When a professional is a therapist treating the client an attends relation should be used. When a professional does not treat the client themself but needs to supervise the treatment a supervises relation should be used. Some organisations may have no use for the supervises relation.

A relation is a JSON object with the following keys:

Name	Value	Value type
`professional`	Related professional	JSON object
`client`	Related client	JSON object
`predicate`	The type of relation	Choice: `attends` or `supervises`

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

The json object professional contains:

Name	Value	Value type
`id`	ID	String
`url`	Canonical URL of the user	String

The json object client contains:

Name	Value	Value type
`id`	ID	String
`url`	Canonical URL of the user	String

Listing client/professional relations ¶

To view the relations a client has with professionals, send a GET request to the relations.items URL. This URL is discoverable in the @links metadata of

a client under the name relations.items;
the client’s relations container under the name items.

Example request:

GET /api/2/c/a42d2968cb9c4186a8449b1d02117e12/relations/items HTTP/1.1
Host: customer.minddistrict.com
Accept: application/json
Authorization: md-token gAAAAABgkqXCmEyh5bzI8-Ll7lPFdAi44AfdtqUuy83vtAu6_PaULrm5_qFMDFNgHfK5NxvZFw4iAL967iCMTR9Gw6Uk535HnDGnoLMYuG8s3VRRK_NnFlu19U0V0oowiQDHY0IBLR4DBpral7j9x25Y7QqXtHQ88Z0Ygfz6a7qIVLzoJbE0nzBE6FFhzTg7-gyiZQc7ES6U

The response will be the list of relations the client has with professionals:

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

{
    "@items": [
        {
            "@type": "http://ns.minddistrict.com/relation",
            "@url": "https://customer.minddistrict.com/api/2/c/a42d2968cb9c4186a8449b1d02117e12/relations/ce26806df891419b9b5b9ecb163d01ef",
            "client": {
                "@type": "http://ns.minddistrict.com/user-reference/client",
                "id": null,
                "url": "https://customer.minddistrict.com/api/2/c/a42d2968cb9c4186a8449b1d02117e12"
            },
            "predicate": "attends",
            "professional": {
                "@type": "http://ns.minddistrict.com/user-reference/professional",
                "id": "tina123456",
                "url": "https://customer.minddistrict.com/api/2/p/3643b732d2404876af7d1038e0ddc784"
            }
        },
        {
            "@type": "http://ns.minddistrict.com/relation",
            "@url": "https://customer.minddistrict.com/api/2/c/a42d2968cb9c4186a8449b1d02117e12/relations/86b45ecc49a541bfb7810a3fe93a83ac",
            "client": {
                "@type": "http://ns.minddistrict.com/user-reference/client",
                "id": null,
                "url": "https://customer.minddistrict.com/api/2/c/a42d2968cb9c4186a8449b1d02117e12"
            },
            "predicate": "attends",
            "professional": {
                "@type": "http://ns.minddistrict.com/user-reference/professional",
                "id": null,
                "url": "https://customer.minddistrict.com/api/2/p/de5e962094e04f708e92b83cf9e2f304"
            }
        }
    ],
    "@links": []
}

Relating a client to a professional ¶

To relate a client to a particular professional, send a POST request to the client’s relations URL. This URL is discoverable in the @links metadata of a client under the name relations.

Specify the relation type ("attends" or "supervises") and the professional to be related (with a professional reference) in the body of the request.

Warning

It is not possible to create multiple relations for the same combination of client, professional and predicate.

The following query:

POST /api/2/c/a42d2968cb9c4186a8449b1d02117e12/relations HTTP/1.1
Host: customer.minddistrict.com
Accept: application/json
Authorization: md-token gAAAAABgkqXDwiLOxI5oI6FsRrKlwJE9Tlle3bPvWUhL15M61j4A-yYqMfouc69ELhIvymLeIxjOk_SZqIZMapGgKyrYUzu-os9Vp7mVL2KlBjwMeuX0hJMx_1CjyMmsfzx4RitIM3b5KVpYfI3YWF97cHPEY1POYdUdxTHPH0IOzJggptPk3d6L6EF1jxZEieJCC9TdywYX
Content-Length: 133
Content-Type: application/json

{
    "@type": "http://ns.minddistrict.com/relation",
    "predicate": "attends",
    "professional": {
        "id": "p1234"
    }
}

The response will be the relation that was created:

HTTP/1.0 201 Created
Cache-Control: max-age=0, no-cache, no-store, must-revalidate
Content-Length: 638
Content-Type: application/json;charset=UTF-8
Location: https://customer.minddistrict.com/api/2/c/a42d2968cb9c4186a8449b1d02117e12/relations/503ea9dc09914efda3a9309b30b74c7f

{
    "@type": "http://ns.minddistrict.com/relation",
    "@url": "https://customer.minddistrict.com/api/2/c/a42d2968cb9c4186a8449b1d02117e12/relations/503ea9dc09914efda3a9309b30b74c7f",
    "client": {
        "@type": "http://ns.minddistrict.com/user-reference/client",
        "id": null,
        "url": "https://customer.minddistrict.com/api/2/c/a42d2968cb9c4186a8449b1d02117e12"
    },
    "predicate": "attends",
    "professional": {
        "@type": "http://ns.minddistrict.com/user-reference/professional",
        "id": "p1234",
        "url": "https://customer.minddistrict.com/api/2/p/8a2ac86f7bea4d6f8833fdca09187046"
    }
}

When the relation can not be created, an error message is returned:

HTTP/1.0 400 Bad Request
Content-Length: 77
Content-Type: application/json;charset=UTF-8

{
    "@links": [],
    "code": 400,
    "message": "Invalid new relation."
}

Removing a client/professional relation ¶

To remove the relation between a client and a professional, send a DELETE request to the relation’s URL. You can find the relation in the client’s relations list.

Example request:

DELETE /api/2/c/a42d2968cb9c4186a8449b1d02117e12/relations/86b45ecc49a541bfb7810a3fe93a83ac HTTP/1.1
Host: customer.minddistrict.com
Accept: application/json
Authorization: md-token gAAAAABgkqXDwiLOxI5oI6FsRrKlwJE9Tlle3bPvWUhL15M61j4A-yYqMfouc69ELhIvymLeIxjOk_SZqIZMapGgKyrYUzu-os9Vp7mVL2KlBjwMeuX0hJMx_1CjyMmsfzx4RitIM3b5KVpYfI3YWF97cHPEY1POYdUdxTHPH0IOzJggptPk3d6L6EF1jxZEieJCC9TdywYX

The response will be an HTTP 204 No Content:

HTTP/1.0 204 No Content
Cache-Control: max-age=0, no-cache, no-store, must-revalidate
Content-Length: 0
Content-Type: text/plain;charset=UTF-8

Relations metadata ¶

To view metadata about the client’s relations container, send a GET request to the relations URL. This URL is discoverable in the @links metadata of

a client under the name relations.

Example request:

GET /api/2/c/a42d2968cb9c4186a8449b1d02117e12/relations HTTP/1.1
Host: customer.minddistrict.com
Accept: application/json
Authorization: md-token gAAAAABgkqXCmEyh5bzI8-Ll7lPFdAi44AfdtqUuy83vtAu6_PaULrm5_qFMDFNgHfK5NxvZFw4iAL967iCMTR9Gw6Uk535HnDGnoLMYuG8s3VRRK_NnFlu19U0V0oowiQDHY0IBLR4DBpral7j9x25Y7QqXtHQ88Z0Ygfz6a7qIVLzoJbE0nzBE6FFhzTg7-gyiZQc7ES6U

Will trigger this result:

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

{
    "@links": [
        {
            "name": "items",
            "url": "https://customer.minddistrict.com/api/2/c/a42d2968cb9c4186a8449b1d02117e12/relations/items"
        }
    ],
    "@type": "http://ns.minddistrict.com/relations/client",
    "@url": "https://customer.minddistrict.com/api/2/c/a42d2968cb9c4186a8449b1d02117e12/relations"
}

Client access log ¶

Information about access to dossiers of clients not in the caseload of the professional is recorded in the “client access log”. This includes searches outside of the professional’s caseload and temporary access requests. The information for the client access log is transferred as json objects containing the following information:

Example request:

GET /api/2/configuration/clientaccess/accesslog/items HTTP/1.1
Host: customer.minddistrict.com
Accept: application/json
Authorization: md-token gAAAAABgkqXGbQW-G_R1_av9odZJYor3vJfHTHA-5Cc7mx967Ux1uXh_kRFWfs8qKmQYOC8oBEpQfqQWflu3Jlx30hKsnysB-UQDe1bi1Rn7ZXfD_2IJETxYVY200hSipd7dzPRQpwC1pVe3zWmUomlwj8UuSFPzEAn4Vp9GTs6BLIGL_GZTx5NCixlDs_mLNqKOeSyuExb-

The response will be a list of log record objects:

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

{
    "@items": [
        {
            "@type": "http://ns.minddistrict.com/error/record",
            "@url": "https://customer.minddistrict.com/api/2/configuration/clientaccess/accesslog/1620223430054624",
            "datetime": "2021-05-05T14:03:50",
            "extra": [
                {
                    "message": "ed12bb91e37c43938a3f8f53cb11e9ea",
                    "name": "client-id"
                },
                {
                    "message": "directly related",
                    "name": "type"
                },
                {
                    "message": "My colleague cannot handle this patient, I will take over",
                    "name": "intention"
                }
            ],
            "message": "Therapist related themself, or requested a relation",
            "user_id": "ed03d9476fb7473dbcd73d21c980c660"
        },
        {
            "@type": "http://ns.minddistrict.com/error/record",
            "@url": "https://customer.minddistrict.com/api/2/configuration/clientaccess/accesslog/1620223430054610",
            "datetime": "2021-05-05T14:03:50",
            "extra": [
                {
                    "message": "ed12bb91e37c43938a3f8f53cb11e9ea",
                    "name": "client-id"
                },
                {
                    "message": "I needed emergency access to the client dossier",
                    "name": "motivation"
                }
            ],
            "message": "Temporary access obtained",
            "user_id": "ed03d9476fb7473dbcd73d21c980c660"
        },
        {
            "@type": "http://ns.minddistrict.com/error/record",
            "@url": "https://customer.minddistrict.com/api/2/configuration/clientaccess/accesslog/1620223430054543",
            "datetime": "2021-05-05T14:03:50",
            "extra": [
                {
                    "message": "Emergency situation, I need to find the patient",
                    "name": "motivation"
                },
                {
                    "message": "{\"motivation\": \"Foobar\", \"term1\": \"value1\", \"term2\": 2001, \"term3\": true, \"professional\": \"theo@example.com\"}",
                    "name": "query"
                }
            ],
            "message": "Search outside of caseload",
            "user_id": "ed03d9476fb7473dbcd73d21c980c660"
        }
    ],
    "@links": [],
    "@paging": {
        "found": 3,
        "limit": null,
        "start": null,
        "total": 3
    }
}

Log record JSON object ¶

Name	Value	Explanation	Value type	Notes
`datetime`	When this error happened	-	Date with time	Required
`user_id`	Internal user ID who triggered this error	-	String	Required
`message`	Error message	-	String	Required
`extra`	Extra information	-	List of mapping

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

Note

Access to the temporary access log API requires the API errors role for the API user.

Client API¶

Client JSON object ¶

Listing clients ¶

Clients search API ¶

Adding a new client ¶

View a client ¶

Editing a client ¶

Activating a client ¶

Merging clients ¶

Client/professional relations ¶

Listing client/professional relations ¶

Relating a client to a professional ¶

Removing a client/professional relation ¶

Relations metadata ¶

Client access log ¶

Log record JSON object ¶

Table of Contents

Previous topic

Next topic