Difference between revisions of "DOxI Documentation"
Jump to navigation
Jump to search
Line 8: | Line 8: | ||
==REST API== | ==REST API== | ||
The MPDL-DOxI REST service can be reached under https://doxi.mpdl.mpg.de/doxi/rest <br/> | The MPDL-DOxI REST service can be reached under https://doxi.mpdl.mpg.de/doxi/rest <br/> | ||
Below all possible functions are listed. (PATH needs to be appended to the base URL | Below all possible functions are listed. (PATH needs to be appended to the base URL) | ||
{| cellpadding="20" cellspacing="0" border="1" | {| cellpadding="20" cellspacing="0" border="1" |
Revision as of 14:25, 19 August 2015
A short introduction into the service called DOxI[edit]
DOxI is a REST API to the MPDL DOI service assigning DataCite DOI names to research data and grey literature.
Access to DOxI is restricted to services registered at MPDL. Please contact us for any further detail.
REST API[edit]
The MPDL-DOxI REST service can be reached under https://doxi.mpdl.mpg.de/doxi/rest
Below all possible functions are listed. (PATH needs to be appended to the base URL)
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} |
- |
- |
|
Authentication[edit]
Authentication is handled by basic http authentication
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