Page tree
Contents

The ARDC DOI service allows for responses to be returned to the client in a number of formats.
By appending the required response format to the service call the client can request the response to be returned in XML, JSON or a string (the default is string).

An example of an XML response follows:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response type="{type}">
<responsecode>{code}</responsecode>
<message>{message}</message> 
<doi>{doi}</doi>
<url>{url}</url>
<app_id>{app_id}</app_id>
<verbosemessage>{verbosemessage}</verbosemessage>
</response>


An example of a JSON response follows:

{"response":{"type":"type","responsecode":"code","message":"message","doi":"doi","url":"url","app_id":"app_id","verbosemessage":"verbosemessage"}}


An example of a string response follows:

[{code}] {message}<br />{verbosemessage}<br/>{url};
(type, code and message will always have values. Doi, url, app_id and verbosemessage will have values where appropriate).

Response Codes

The possible responses to DOI M2M service requests are shown in the below table.

Code

Type

Message

MT001

success

DOI {doi} was successfully minted.

MT002

success

DOI {doi} was successfully updated.

MT003

success

DOI {doi} was successfully inactivated.

MT004

success

DOI {doi} was successfully activated.

MT005

failure

The DOI service is currently unavailable. Please try again at a later time. If you continue to experience problems please contact services@ardc.edu.au.

MT006

failure

The metadata you have provided to mint/reserve a new DOI has failed the schema validation. Metadata is validated against the latest version of the DataCite Metadata Schema. For information about the schema and the latest version supported, please visit DataCite Metadata Schema.

Detailed information about the validation errors can be found below.

MT007

failure

The metadata you have provided to update DOI {doi} has failed the schema validation. Metadata is validated against the DataCite Metadata Schema. For information about the schema and the latest version supported, please visit DataCite Metadata Schema. 

information about the validation errors can be found below.

MT008

failure

You do not appear to be the owner of DOI {doi}. If you believe this to be incorrect please contact services@ardc.edu.au.

MT009

failure

You are not authorised to use this service. For more information or to request access to the service please contact services@ardc.edu.au.

MT010

failure

There has been an unexpected error processing your doi request. For more information please contact services@ardc.edu.au.

MT011

failure

DOI {doi} does not exist in the ARDC DOI service.

MT012

failure

No metadata exists in the DOI service for DOI {doi}

MT013

success

This response code will be received when successfully retrieving the metadata associated with a DOI with a response type of json requested. The message for this code will be the DOI's metadata provided in an XML document. For more information please see the service point description in section 3.10.5 Get DOI Metadata.

MT014failureThe provided URL does not belong to any of your registered top level domains. If you would like to add additional domains to your account please contact services@ardc.edu.au.
MT015successDOI {doi} was successfully reserved.
MT016successReserved DOI {doi} was successfully minted.
MT017failureThe DOI {doi} provided to mint/reserve a DOI does not match the DOI prefix allocated to your account. For more information, please contact services@ardc.edu.au.
MT018failureNo metadata exists for the requested DOI. Metadata must be registered before the DOI can be minted.
MT019success{doi status}

MT090

success

The rocket is ready to blast off – all systems are go!

MT091

failure

Uh oh! DOI Service unavailable (unable to process upstream DOI request). Please try again in a few moments.

Note: In most failure situations a more verbose message will be appended to the response. This verbose message may be the error message returned from DataCite or a more explanatory message about the actual error.