Difference between revisions of "DOxI Documentation"
Jump to navigation
Jump to search
Line 1: | Line 1: | ||
== Short introduction into the service called DOxI == | |||
DOxI is a [https://en.wikipedia.org/wiki/Representational_state_transfer REST API] to the [http://doi.mpdl.mpg.de/ MPDL DOI service] which can be used to assign DataCite DOI names to research data and grey literature. Access to DOxI is restricted to services registered at MPDL. | |||
[http://doi.mpdl.mpg.de/contact/ Contact us] to learn more... | |||
==REST API== | ==REST API== |
Revision as of 12:00, 19 August 2015
Short introduction into the service called DOxI[edit]
DOxI is a REST API to the MPDL DOI service which can be used to assign DataCite DOI names to research data and grey literature. Access to DOxI is restricted to services registered at MPDL.
Contact us to learn more...
REST API[edit]
Function | HTTP method | Path | Body | URL Parameter | Success return value |
---|---|---|---|---|---|
Create DOI | PUT | /doi/{doi} | Metadata in XML format. DOI in XML will be replaced. |
|
|
Generate DOI | PUT | /doi | Metadata in XML format. DOI in XML will be replaced. |
|
|
Update DOI | POST | /doi/{doi} | Metadata in XML format (optional), if it should be updated. DOI in XML will be replaced. |
|
|
Get DOI | GET | /doi/{doi} |
- |
- |
|
Get DOI List | GET | /doi |
- |
- |
|
Inactivate DOI | DELETE | /doi/{doi} |
- |
- |
|
Exceptions[edit]
- DoxiException as super class
- DoiAlreadyExistsException
- StatusCode: 409
- Message: This DOI already exists. You can either choose another DOI for creating a new DOI or update the existing one by using the update methode.
- DoiInvalidException
- StatusCode: 400
- Message: This DOI already exists. You can either choose another DOI for creating a new DOI or update the existing one by using the update methode.
- UrlInvalidException
- StatusCode: 400
- Message: The transfered URL is invalid. This can for example be caused by a syntax error.
- MetadataInvalidException
- StatusCode: 400
- Message: Datacite response message if available
- Alternative Message: The transfered metadata xml is invalid. Please refer to the datacite xml schema (https://schema.datacite.org/).
- MetadataXml included
- DoiRegisterException
- StatusCode: 400
- Message: Datacite response message if available
- Alternative Message: The DOI could not be registered at the datacite service.
- DoiAlreadyExistsException