Difference between revisions of "DOxI Documentation"
Jump to navigation
Jump to search
Haarlaender (talk | contribs) |
|||
Line 2: | Line 2: | ||
a short introduction into the MPDL DOI service called DOxI | a short introduction into the MPDL DOI service called DOxI | ||
==REST API== | |||
{| cellpadding="20" cellspacing="0" border="1" | |||
!Function | |||
!HTTP method | |||
!Path | |||
!Body | |||
!URL Parameter | |||
!Return value | |||
|- | |||
!Create DOI | |||
| PUT | |||
|/doi/{doi} | |||
|Metadata in XML format. DOI in XML will be replaced. | |||
| | |||
*url (required): Target URL for this DOI | |||
|created DOI in text/plain format | |||
|- | |||
!Generate DOI | |||
|PUT | |||
|/doi | |||
|Metadata in XML format. DOI in XML will be replaced. | |||
| | |||
* url (required): Target URL for this DOI | |||
* suffix (optional): Desired suffix for this DOI | |||
|created DOI in text/plain format | |||
|- | |||
!Update DOI | |||
|POST | |||
|/doi/{doi} | |||
|Metadata in XML format (optional), if it should be updated. DOI in XML will be replaced. | |||
| | |||
* url (optional): Target URL for this DOI, if it should be updated | |||
| DOI in text/plain format | |||
|- | |||
!Get DOI | |||
|GET | |||
|/doi/{doi} | |||
| | |||
- | |||
| | |||
- | |||
| DOI in text/plain format | |||
|- | |||
!Get DOI List | |||
|GET | |||
|/doi | |||
| | |||
- | |||
| | |||
- | |||
| DOIs in text/plain format | |||
|- | |||
!Inactivate DOI | |||
|DELETE | |||
|/doi/{doi} | |||
| | |||
- | |||
| | |||
- | |||
| | |||
- | |||
|} | |||
==Exceptions== | ==Exceptions== |
Revision as of 14:33, 5 May 2015
This is a protected page.
a short introduction into the MPDL DOI service called DOxI
REST API[edit]
Function | HTTP method | Path | Body | URL Parameter | Return value |
---|---|---|---|---|---|
Create DOI | PUT | /doi/{doi} | Metadata in XML format. DOI in XML will be replaced. |
|
created DOI in text/plain format |
Generate DOI | PUT | /doi | Metadata in XML format. DOI in XML will be replaced. |
|
created DOI in text/plain format |
Update DOI | POST | /doi/{doi} | Metadata in XML format (optional), if it should be updated. DOI in XML will be replaced. |
|
DOI in text/plain format |
Get DOI | GET | /doi/{doi} |
- |
- |
DOI in text/plain format |
Get DOI List | GET | /doi |
- |
- |
DOIs in text/plain format |
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