An identifier will be "created" based on the information provided. If a suffix is not provided, a suffix will be minted or generated. By default all identifiers will be created with a state set to "draft".

HTTP Method

POST

URI

https://rucore.libraries.rutgers.edu/api/purl/doi/create/

Restricted

Authorization key required

Arguments

• id : string
  required Unique identifier of the item in the repository
• key : string
  required Authorization key
• suffix : string
  optional A unique suffix to use when registering the DOI. If not provided an opaque identifier will be minted/generated.

Sample Response

The presence of a <status_code> with a value of 201 signals a successful request. The new identifiers are in the <doi> and <ark> sub-elements to the <response> element.

Sample Error

When an error occurs the <status_code> will provide a value other than 201. These <status_code> values are based on HTTP Status Codes. An <error> sub-element containing a helpful message will also be provided.

Deletes an identifier if its state is "draft."

HTTP Method

DELETE

URI

https://rucore.libraries.rutgers.edu/api/purl/doi/delete/

Restricted

Authorization key required

Arguments

• id : string
  required Unique identifier of the item in the repository or a DOI managed under the shoulder this service is provided.
• key : string
  required Authorization key

Sample Response

The presence of a <status_code> with a value of 204 signals a successful request. The <success> sub-element provides a message as to what was deleted.

Sample Error

When an error occurs the <status_code> will provide a value other than 204. These <status_code> values are based on HTTP Status Codes. An <error> sub-element containing a helpful message will also be provided.

Either reports the current state of an identifier or changes the state of an identifier. The state of an identifier can either be changed to "findable" or "registered".

HTTP Method

POST

URI

https://rucore.libraries.rutgers.edu/api/purl/doi/state/

Restricted

Authorization key required.

Arguments

• id : string
  required Unique identifier of the item in the repository or a DOI managed under the shoulder this service is provided.
• key : string
  required Authorization key
• action : string, enumerated (current, update)
  required Passing a value of "current" reports the current state of the DOI at the provider. Passing a value of "update" will change the current state of the DOI to the value specified by the state argument.
• state : string, enumerated (findable, registered)
  conditional This argument is required when passing an action argument set to "update". Acceptable values are "findable" and "registered." Identifiers that are currently marked as "draft" or "findable" can be changed to "registered." When an identifier is initially created it's default state is "draft" and either the "draft" or "registered" state can be changed to "findable."
• reason : string
  optional When updating a DOI to a state of "registered" a reason can be attached. This reason will be displayed when visiting the DOI tombstone page.

Sample Response (action=current)

The presence of a <status_code> with a value of 200 signals a successful request. The <state> sub-element provides a current state of the identifier; draft, findable or registered.

Sample Error (action=current)

When an error occurs the <status_code> will provide a value other than 200. These <status_code> values are based on HTTP Status Codes. An <error> sub-element containing a helpful message will also be provided.

Sample Response (action=update)

The presence of a <status_code> with a value of 200 signals a successful request. The <success> sub-element provides a helpful message.

Sample Error (action=update)

When an error occurs the <status_code> will provide a value other than 200. These <status_code> values are based on HTTP Status Codes. An <error> sub-element containing a helpful message will also be provided.

When metadata requirements have not been satisfied the state of a DOI cannot be changed. In this case it is recommended that the Update method be run before attempting to change the state of the DOI.

If the source is set to "repository" this method generates metadata suitable for the DOI registrar. When the source is set to "registrar" the currently stored metadata at the registrar is retrieved and returned.

HTTP Method

POST

URI

https://rucore.libraries.rutgers.edu/api/purl/doi/metadata/

Restricted

Authorization key required.

Arguments

• id : string
  required Unique identifier of the item in the repository when source is "repository", DOI when the source is set to "registrar"
• key : string
  required Authorization key
• source : string, enumerated (repository, registrar)
  required Source of the metadata

Sample Response (source=repository)

On a successful request the metadata is returned in xml.

Sample Error (source=repository)

When an error occurs the <status_code> will be 400. An <error> sub-element containing a helpful message will also be provided.

Sample Response (source=registrar)

On a successful request the metadata is returned in xml.

Sample Error (source=registrar)

When an error occurs the <status_code> will provide a value of 400. An <error> sub-element containing a helpful message will also be provided.

Reports the current status of the DOI provider and/or a subsystem.

HTTP Method

GET

URI

https://rucore.libraries.rutgers.edu/api/purl/doi/status/{subsystem}

Arguments

• subsystem : string
  optional Name of a particular DOI subsystem you would like the status of. Using the wildcard(*) all subsystem statuses will be returned.

Sample Response

The presence of a <status_code> with a value of 200 signals a successful request. The <success> sub-element provides a helpful message.

Sample Error (source=repository)

When an error occurs the <status_code> will be 400. An <error> sub-element containing a helpful message will also be provided.

Updates metadata at the registrar for a given repository resource.

HTTP Method

POST

URI

https://rucore.libraries.rutgers.edu/api/purl/doi/update/

Restricted

Authorization key required.

Arguments

• id : string
  required Unique identifier of the item in the repository
• key : string
  required Authorization key

Sample Response

The presence of a <status_code> with a value of 200 signals a successful request. The <success> sub-element provides a helpful message.

Sample Error (source=repository)

When an error occurs the <status_code> will be 400. An <error> sub-element containing a helpful message will also be provided.

Changes the target URI for a given DOI.

HTTP Method

POST

URI

https://rucore.libraries.rutgers.edu/api/purl/doi/change/target/

Restricted

Authorization key required.

Arguments

• doi : string
  required DOI needing target changed
• target : string
  required New URL-encoded target
• key : string
  required Authorization key

Sample Response

The presence of a <status_code> with a value of 200 signals a successful request. The <success> sub-element provides a helpful message.

Sample Error (source=repository)

When an error occurs the <status_code> will be 400. An <error> sub-element containing a helpful message will also be provided.

Tests a repository resource is registered properly by comparing the DOI stored in the resources metadata with the actual DOI response.

HTTP Method

GET

URI

https://rucore.libraries.rutgers.edu/api/purl/doi/verify/{id}

Restricted

Authorization key required.

Arguments

• id : string
  required Unique identifier of the item in the repository
• key : string
  required Authorization key

Sample Response

The presence of a <status_code> with a value of 200 signals a successful request. The <success> sub-element provides a helpful message.

Sample Error

When an error occurs the <status_code> will be 400. An <error> sub-element containing a the repository <target> and <doi> for the resource are returned to aid further troubleshooting.