Documentation

What’s new?

Release 2.38 (2020-03-20)

  • Export API now validates its input correct when creating an export job, instead of accepting it and then having the export fail.
  • Video usage by professionals export now allows for a custom period parameter.

Release 2.37 (2020-03-03)

  • User login export exports the individual login times for all users.
  • User activity period export exports the individual activity period on the platform for all users.
  • Video usage by professionals export summarize the usage of the video call feature by each professional.

Release 2.36 (2020-02-05)

  • The video call export is no longer available and thus removed from the documentation.

Release 2.35 (2020-01-09)

Release 2.34 (2019-11-29)

  • external_source attribute was added to professional and client serialization. This attribute indicates the origin source of information for the user account. Read only. Can be null.

Release 2.33 (2019-10-30)

  • Export documentation has been improved.

Release 2.32 (2019-10-04)

  • Module step export now include offset in source. Offset in source and offset in content are not set if the step is generated because of the structure of the topic.

Release 2.31 (2019-09-30)

Release 2.30 (2019-07-31)

  • Action plans are the first of the new style plan features. The export for Action plan is available at: Action plan export.

Release 2.29 (2019-07-02)

  • Update documentation about the planning API.

Release 2.28 (2019-06-06)

  • Module steps export has a new property maximum visible offset.
  • All users export have a new property creator.
  • An API user export was added, as it can be a valid creator of an another user.

Release 2.27 (2019-05-02)

  • API users can now upload a profile picture for a professional and/or a client.
  • Personal routes steps export has been removed from the export API. Module steps export has been introduced to replace it. The two exports are not compatible with each other.

Release 2.26 (2019-02-27)

  • Expanded the documentation of the client relations API to explain how we handle duplicate relations between clients and professionals.
  • File and images are now serialized with more information than before. When uploading one, a filename can now be set.

Release 2.25 (2019-01-09)

  • Add ‘other’ and ‘unknown’ to Gender.
  • In the export export API, the field last login was renamed to last usage. Usage from mobile applications is now also registered in the last usage data.

Release 2.24 (2018-10-03)

  • Add group ids property to professionals export API.

Release 2.23 (2018-07-30)

  • Sign-up applications and anonymous sign-up applications have been added to the available exports.

Release 2.22 (2018-07-05)

Release 2.21 (2018-05-29)

  • Video calls and friends exports have been added to the available exports. Some additional properties have been added to the already existing exports.

Release 2.20 (2018-05-01)

  • Additional properties have been added to the available exports and the documentation has been improved.

Release 2.19 (2018-03-26)

Release 2.18 (2018-01-02)

  • A relation export has been added.

Release 2.17 (2017-11-17)

  • Labels have been added on tools and in the export feature.
  • Diary export has been renamed to diary entry export.

Release 2.16 (2017-11-03)

  • In the Export API is available as a beta feature.

Release 2.15 (2017-09-01)

  • In the Application API several application specific values are published.

Release 2.14 (2017-05-24)

Release 2.13 (2017-03-27)

  • The profile picture is now published in Client API

Release 2.12 (2017-02-17)

Release 2.11 (2017-01-02)

Release 2.10 (2016-11-25)

  • Document partial edition of diary entries.

Release 2.9 (2016-09-30)

  • You can now optionally not send an email while deactivating a client.

Release 2.8 (2016-05-06)

Release 2.7 (2016-01-04)

  • Fix misleading JSON in client activation example.
  • Explain difference between attends and supervises relationship between client and professional.

Release 2.6 (2015-12-02)

Release 2.5 (2015-11-06)

Release 2.1 (2015-04-24)

Release 2.0 (2015-02-13)

  • The Diary API has been worked over, and the documentation improved. Note that the URLs have changed: you can not upgrade your version 1 diary URLs simply by replacing the version number in the path.
    • The most significant change is that diaries such as emotion and moment are now defined by schemas which may be configured by a professional working in the Minddistrict platform; the API has been updated to report these schemas wherever they are relevant.
    • The schema format is documented, including the configuration options used in the Minddistrict platform to specify charts and computed fields.
    • Diary URLs are now discoverable on the client endpoint: this avoids needing a succession of API calls to get from the client URL (given on successful login) to the URLs with which you can read and create diary entries.
  • The documentation has been updated to make the discovery mechanism more explicit and more prominent. The 2.0 release provides and documents this mechanism systematically for the diary URLs; minor point releases (2.1, 2.2, etc) will extend this treatment (in a backwards-compatible manner) to existing APIs such as the client and professional APIs.

Index

Full table of contents