DOI Proxy Query Command Format

<< Click to Display Table of Contents >>

Navigation:  Appendix >

DOI Proxy Query Command Format

The format of a resolution query command to the DOI Proxy (see DOI Proxy) is as follows:

https://doi.org/<doi-name>?<param_1>&<param_2>&..

where:

<doi-name>: DOI name to be resolved

<param_i>: parameter i passed to the DOI Proxy

Example: https://doi.org/10.1000/1?noredirect&type=URL

NOTE  HTTP instead of HTTPS as well as dx.doi.org instead of doi.org are still supported (but not recommended).

The following table lists the native parameters supported in a query sent to the DOI Proxy. (Other parameters may be passed through the proxy using the urlappend parameter.)

 

Parameter

Description

See

noredirect

Do not redirect using URL or 10320/loc type elements. Display the elements instead.

 

ignore_aliases

Ignore HS_ALIAS elements.

The HS_ALIAS element is used to specify a Handle that should be resolved instead of the input Handle.

 

auth

Authoritative query. The DOI Proxy bypasses its cache and sends its resolution request to an authoritative Handle service (it means to a primary service, not to a mirror service).

 

cert

Certified query. The DOI Proxy requires an authenticated response from the Handle service (it means that the DOI Proxy asks the Handle service to sign its response and the Proxy will check the signature before accepting it).

 

index=<value>

Resolve the DOI record element at the specified index value and do not resolve the other elements except if otherwise required. May be repeated to resolve multiple indexes.

Introduction to the Handle Record

type=<value>

Resolve the DOI record element of the specified type value and do not resolve the other elements except if otherwise required. May be repeated to resolve multiple types.

Introduction to the Handle Record

urlappend=<value>

Append the value of this parameter to the end of the URL used for redirection.

 

locatt=<key>:<value>

In case of a multiple resolution: use this key:value pair for the interpretation of the 10320/LOC element.

Multiple DOI Resolution (Multiple URLs)

action=showurls

In case of a multiple resolution: return an XML representation of the possible redirect locations stored in the 10320/LOC element.

Multiple DOI Resolution (Multiple URLs)

All combinations of parameters are accepted (not all are useful). For example, if the index and type query parameters are used together then any element which matches any of the specified indexes or types is returned.