DOxI Documentation

Authentication

Authentication is handled by 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
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.	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

• 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.

PID REST API

The MPDL PID-REST service can be reached under https://doxi.mpdl.mpg.de/doxi

Max Planck Digital Library

Digital Object Identifier

Representational State Transfer

Application Programming Interface

Uniform Resource Locator

HyperText Transfer Protocol

Extensible Markup Language

Persistent Identifer or Identification