Difference between revisions of "DOxI Documentation"
Jump to navigation
Jump to search
Haarlaender (talk | contribs) m |
|||
Line 1: | Line 1: | ||
a short introduction into the MPDL DOI service called DOxI | a short introduction into the MPDL DOI service called DOxI | ||
==REST API== | ==REST API== |
Revision as of 11:43, 19 August 2015
a short introduction into the MPDL DOI service called DOxI
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