Page tree
Contents

Get Service Status | Mint a DOI | Update a DOI | Activate a DOI | Deactivate a DOI | Get DOI Status | Get a DOI Metadata |

Get Service Status

Checks the status of the Cite My Data Service.

  • If the Cite My Data service is operational, a successful message MT090 will be returned;
  • If the Cite my Data service is online but unable to mint DOIs, a failure message MT091 will be returned; and
  • Where the service is completely offline no response will be sent.

Service Point

https://researchdata.ands.org.au/api/doi/status.{response_type}/

Service Type

Get

Service Point Parameters

Name

Required?

Description

Example

response_type

Yes

Preferred service response format.


Must be one of:

    • json
    • xml
    • string

NA

Mint a DOI

Mints a new DOI with associated metadata.

Service Point

https://researchdata.ands.org.au/api/doi/mint.{response_type}/?app_id={app_id}&url={url}

Service Type

Post

Service Point Post Variables

Name

Required?

Description

Example

xml

Yes

The DataCite xml which describes the citation information of the requested doi

Please refer to the DataCite Metadata Schema documentation.

Service Point Parameters

Name

Required?

Description

Example

response_type

Yes

Preferred service response format.

Must be one of:

  • json
  • xml
  • string

NA

app_id

Yes

Client's application id provided by ANDS during client registration

0ca474877510b101b26f9e4192bacba9ca762b15

url

Yes

URL where the minted doi will resolve to. The url must fall within the top level domain(s) you have registered with your Cite My Data account.

http://example.domain.com/filename.html

Note: Identifiers for DOIs are automatically generated by the Cite My Data service and do not need to be passed as parameters in the 'Identifier' metadata element when minting a DOI. Any text passed through in the 'Identifier' element within the metadata will be overwritten.

Update a DOI

Updates a DOI. The DOI being updated must belong to the client requesting the update. The update service point allows clients to update their DOIs in 3 ways. Clients can update the URL only, metadata only, or both the URL and metadata.

Service Point

https://researchdata.ands.org.au/api/doi/update.{response_type}/?app_id={app_id}&doi={doi}&url={url}

Service Type

Post

Service Point Post Variables

Name

Required?

Description

Example

xml

Yes if updating the xml

The DataCite xml which describes the citation information of the requested doi

Please refer to the DataCite Metdata Schema  documentation.

Service Point Parameters

Name

Required?

Description

Example

response_type

Yes

Preferred service response format.

Must be one of:

  • json
  • xml
  • string

NA

app_id

Yes

Client's application id provided by ANDS during client registration

0ca474877510b101b26f9e4192bacba9ca762b15

doi

Yes

Value of doi to be updated

10.5072/01/4DD9C98890330

url

Yes if updating the url

URL where the minted doi will resolve to. The url must fall within the top level domain(s) you have registered with your Cite My Data account.

http://example.domain.com/filename.html

 

Deactivate a DOI

Deactivates metadata associated with a DOI. A DOI's metadata is active by default.
Marking a DOI as inactive prevents the DOI's metadata from being returned by the public 'Get DOI Metadata' service endpoint, and by DataCite's Metadata Search and OAI-PMH feed. Deactivating the DOI does not delete it, the DOI will continue to resolve to the URL associated with it.

Service Point

https://researchdata.ands.org.au/api/doi/deactivate.{response_type}/?app_id={app_id}&doi={doi}

Service Type

Get

Service Point Parameters

Name

Required?

Description

Example

response_type

Yes

Preferred service response format.

Must be one of:

  • json
  • xml
  • string

NA

app_id

Yes

Client's application id provided by ANDS during client registration

0ca474877510b101b26f9e4192bacba9ca762b15

doi

Yes

Value of active doi to be deactivated

10.5072/01/4DD9C98890330

 

Activate a DOI

Activates deactivated metadata associated with a given DOI. A DOI's metadata is active by default, and can only by activated if it has previously been deactivated. Activating a DOI's metadata allows the metadata to be returned by the public 'Get DOI Metadata' service endpoint, and by DataCite's Metadata Search and OAI-PMH feed.

Service Point

https://researchdata.ands.org.au/api/doi/activate.{response_type}/?app_id={app_id}&doi={doi}

Service Type

Get

Service Point Parameters

Name

Required?

Description

Example

response_type

Yes

Preferred service response format.

Must be one of:

  • json
  • xml
  • string

NA

app_id

Yes

Client's application id provided by ANDS during client registration

0ca474877510b101b26f9e4192bacba9ca762b15

doi

Yes

Value of deactivated doi to be activated

10.5072/01/4DD9C98890330

 

Get DOI Status

Gets the status of a given DOI (ACTIVE, INACTIVE or RESERVED).

Service Point

https://researchdata.ands.org.au/api/doi/doistatus.{response_type}/?app_id={app_id}&doi={doi}

Service Type

Get

Service Point Parameters

Name

Required?

Description

Example

response_type

Yes

Preferred service response format.

Must be one of:

  • json
  • xml
  • string

NA

app_id

Yes

Client's application id provided by ANDS during client registration

0ca474877510b101b26f9e4192bacba9ca762b15

doi

Yes

The DOI the status should be returned for

10.5072/4DD9C98890330

Get DOI Metadata

Publically accessible service point which returns the metadata associated with a given DOI.

Service Point

https://researchdata.ands.org.au/api/doi/xml.{response_type}/?doi={doi}

Service Type

Get

Service Point Parameters

Name

Required?

Description

Example

response_type

Yes

Preferred service response format.

Must be one of:

  • json
  • xml
  • string

  • Note: When a response format of json is requested, the XML metadata document will be contained in the "message" attribute. The length of the document will also be provided in the "verbosemessage" attribute.

NA

doi

Yes

Value of doi to be retrieved

 
  • No labels