Skip to content

API documentation

dsisu edited this page Nov 1, 2023 · 8 revisions

DMPRoadmap currently provides 2 different main threads of it's API due to varying needs of specific audience types. The threads are referred to as 'Version 0' which supports the early needs of organizational administrators and 'Version 1' provides support for ongoing networked DMP (maDMP) use cases. Detailed documentation for both API threads can be accessed through the links below.

Version 0

Version zero was designed to provide organizational administrators with access to the full text of all of their users' plans. We continue to support this version of the API because it's functionality does not tie into the use cases supported by the other versions of the API at this time. Please note that this version has support long term and will be patched only to provide necessary security updates.

Version 1

The V1 version of the API is designed for integrations with other systems and applications. It uses the RDA common metadata standard for DMPs to communicate metadata about a DMP. It does not provide access to the full text narrative portion of a DMP (aside from the ability to download a PDF).

Versioning policy

While we provide ongoing support for V0, the V1 API only receives support for the 2 most recent versions going forward. When a new major API version is released, we guarantee full support for the latest version. In addition, we give 12 months notice before retiring the previous major version, and send periodic reminder emails to those members still using it during the notice period.