Difference between revisions of "DOxI Documentation"
Jump to navigation
Jump to search
Line 108: | Line 108: | ||
The MPDL PID-REST service can be reached under https://doxi.mpdl.mpg.de/doxi <br/> | The MPDL PID-REST service can be reached under https://doxi.mpdl.mpg.de/doxi <br/> | ||
[[File:PidCache.png]] | [[File:PidCache.png]] | ||
[[Category:DOxI]] | [[Category:DOxI]] |
Revision as of 15:14, 16 November 2016
DOI REST API[edit]
The MPDL DOI-REST service can be reached under https://doxi.mpdl.mpg.de/doxi
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
PID REST API[edit]
The MPDL PID-REST service can be reached under https://doxi.mpdl.mpg.de/doxi