Difference between revisions of "DOxI Documentation"
Jump to navigation
Jump to search
(Created page with "<accesscontrol>MPDL</accesscontrol> =DOxI DOCUMENTATION= a short introduction into the MPDL DOI service called DOxI ==Exceptions== *DoxiException as super class **DoiAlrea...") |
Haarlaender (talk | contribs) |
||
(35 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
==Authentication== | |||
Authentication is handled by [https://de.wikipedia.org/wiki/HTTP-Authentifizierung#Basic_Authentication basic http authentication]. Please contact the MPDL DOI Service for any questions. | |||
==DOI REST API== | |||
The MPDL DOI-REST service can be reached under https://doxi.mpdl.mpg.de/doxi <br/> | |||
Below all possible functions are listed. (PATH needs to be appended to the base URL) | |||
= | {| cellpadding="20" cellspacing="0" border="1" | ||
a | !Function | ||
!HTTP method | |||
!Path | |||
!Body | |||
!URL Parameter | |||
!Success return value | |||
|- | |||
!Create DOI | |||
| PUT | |||
|/doi/rest/v1/{doi} | |||
|Metadata in XML format. DOI in XML will be replaced. | |||
| | |||
*url: Target URL for this DOI. If no URL is given, a draft DOI is created (not findable). Use the update method to provide the URL later. | |||
| | |||
*HTTP Status: 201 - CREATED and findable | |||
*HTTP Status: 202 - CREATED and in draft state | |||
*Body: created DOI in text/plain format | |||
|- | |||
!Generate DOI | |||
|PUT | |||
|/doi/rest/v1 | |||
|Metadata in XML format. DOI in XML will be replaced. | |||
| | |||
* url: Target URL for this DOI. If no URL is given, a draft DOI is created (not findable). Use the update method to provide the URL later. | |||
* suffix (optional): Desired suffix for this DOI | |||
| | |||
*HTTP Status: 201 - CREATED | |||
*HTTP Status: 202 - CREATED and in draft state | |||
*Body: created DOI in text/plain format | |||
|- | |||
!Update DOI | |||
|POST | |||
|/doi/rest/v1/{doi} | |||
|Metadata in XML format (optional), if it should be updated. DOI in XML will be replaced. | |||
| | |||
* url (required): Target URL for this DOI (please repeat the URL, even if you want to update metadata only) | |||
| | |||
*HTTP Status: 201 - CREATED | |||
*Body: Metadata in application/xml format | |||
*Header 'Location': Target URL of DOI | |||
|- | |||
!Get DOI | |||
|GET | |||
|/doi/rest/v1/{doi} | |||
| | |||
- | |||
| | |||
- | |||
| | |||
*HTTP Status: 200 - OK | |||
*HTTP Status: 204 - DOI in draft state, no URL available | |||
*Body: Metadata in application/xml format | |||
*Header 'Location': Target URL of DOI | |||
|- | |||
!Get DOI List | |||
|GET | |||
|/doi/rest/v1 | |||
| | |||
- | |||
| | |||
- | |||
| | |||
*HTTP Status: 200 - OK | |||
*Body: DOIs in text/plain format | |||
|- | |||
!Inactivate DOI | |||
|DELETE | |||
|/doi/rest/v1/{doi} | |||
| | |||
- | |||
| | |||
- | |||
| | |||
*HTTP Status: 200 - OK | |||
|} | |||
==Exceptions== | ==Exceptions== | ||
Line 26: | Line 109: | ||
***Alternative Message: The DOI could not be registered at the datacite service. | ***Alternative Message: The DOI could not be registered at the datacite service. | ||
==PID REST API== | |||
The MPDL PID-REST service can be reached under https://doxi.mpdl.mpg.de/doxi <br/> | |||
[[File:PidService.png]] | |||
[[File:PidCache.png]] | |||
[[Category: | [[Category:DOxI]] |
Latest revision as of 09:25, 31 March 2020
Authentication[edit]
Authentication is handled by basic http authentication. Please contact the MPDL DOI Service for any questions.
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/rest/v1/{doi} | Metadata in XML format. DOI in XML will be replaced. |
|
|
Generate DOI | PUT | /doi/rest/v1 | Metadata in XML format. DOI in XML will be replaced. |
|
|
Update DOI | POST | /doi/rest/v1/{doi} | Metadata in XML format (optional), if it should be updated. DOI in XML will be replaced. |
|
|
Get DOI | GET | /doi/rest/v1/{doi} |
- |
- |
|
Get DOI List | GET | /doi/rest/v1 |
- |
- |
|
Inactivate DOI | DELETE | /doi/rest/v1/{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
PID REST API[edit]
The MPDL PID-REST service can be reached under https://doxi.mpdl.mpg.de/doxi