Article (Full Text) Retrieval API

This represents retrieval of the full text article. Full text articles might also have links to a Scopus abstract representation of the resource. The article also includes links to embedded and related objects. The text of these articles are available for searching through use of the ScienceDirect Search API.



The native format of the article text is XML and while portions of it can be translated to JSON, the complexity of the mark-up prevents the full text from being accurately represented in JSON format.



The primary schema for the 'xocs:doc' element of the full article can be found at https://schema.elsevier.com/dtds/document/fulltext/xcr/xocs-article.xsd. Other supporting schemas can be found at https://schema.elsevier.com/dtds/document/fulltext/xcr/.



The following chart shows the Article Retrieval Views.



Note: As of 2017, Aug 29 this API no longer supports the retrieval of HTML, ePub, or MOBI response formats.

Summary

Resource Method Description
https://api.elsevier.com/content/article/doi/{doi} GET
Article Retrieval API: This represents retrieval of a full text article by DOI (Document Object Identifier).
https://api.elsevier.com/content/article/pii/{pii} GET
Article Retrieval API: This represents retrieval of a full text article by PII (Publication Item Identifier).
https://api.elsevier.com/content/article/eid/{eid} GET
Article Retrieval API: This represents retrieval of a full text article by EID (Electronic Identifier). This can either be the full-text article identifier or the corresponding Scopus abstract identifier.
https://api.elsevier.com/content/article/scopus_id/{scopus_id} GET
Article Retrieval API: This represents retrieval of a full text article by Scopus ID.
https://api.elsevier.com/content/article/pubmed_id/{pubmed_id} GET
Article Retrieval API: This represents retrieval of a full text article by Pubmed ID (Medline ID).

Resources


https://api.elsevier.com/content/article/doi/{doi}

Article Retrieval API: This represents retrieval of a full text article by DOI (Document Object Identifier).

Methods
GET simple()

request
header params
Accept xsd:string
(required)
default: text/xml
options: text/xml, application/json, application/pdf, image/png, text/plain, application/rdf+xml
This represents the acceptable mime types in which the response can be generated. This can also be submitted as the query string parameter "httpAccept". This returns the response in JSON, ATOM, or XML mark-up.
Authorization xsd:string This header field contains the OAuth bearer access token in which the format of the field is "Bearer <token>" (where the token represents the end-user session key). The presence of a bearer token implies the request will be executed against user-based entitlements. The Authorization field overrides X-ELS-Authtoken.
X-ELS-APIKey xsd:string
(required)
This represents a unique application developer key providing access to API resources. This key can also be submitted as the query string parameter "apiKey"
X-ELS-Authtoken xsd:string This represents a end-user session. If provided, this token is used to validate the credentials needed to access content in this resource. This token can also be submitted through the HTTP header "Authorization" or the query string parameter "access_token".
X-ELS-Insttoken xsd:string This represents a institution token. If provided, this key (in combination with its associated APIKey) is used to establish the credentials needed to access content in this resource. This token can also be provided through the query string parameter "insttoken".
CR-Clickthrough-Client-Token xsd:string This Crossref standard extension header field contains a Crossref client token, which can be used in place of an API Key. This token can be used in conjunction with an authentication token or, if not provided, authentication will be accounted for through the IP address associated with the request. This replaces the old versions of the token CR-TDM-Client-Token and CR-Prospect-Client-Token. Additional information about use of Crossref and publishers can be found at Crossref Text and Data Mining"
CR-TDM-Client-Token xsd:string (Deprecated)This Crossref standard extension header field chas been replaced by CR-Clickthrough-Client-Token.
X-ELS-ReqId xsd:string This is a client-defined request identifier, which will be logged in all trace messages of the service. This identifier can be used to track a specific transaction in the service's message logs. It will also be returned as an HTTP header in the corresponding response. Note that this should be a unique identifier for the client, and used to track a single transaction.
X-ELS-ResourceVersion xsd:string
options: new
Represents the version of the resource that should be received. Note that submitting new always returns the latest response version.

query params
httpAccept xsd:string
options: text/xml, application/json, application/pdf, image/png, plain/text, application/rdf+xml
Override for HTTP header Accept, this represents the acceptable mime types for which the response can be generated.
access_token xsd:string Override for HTTP header Authorization, this contains the OAuth bearer access token, where the format of the field is "<token>" (where the token represents the end-user session key). The presence of a bearer token implies the request will be executed against user-based entitlements.
insttoken xsd:string Override for HTTP header X-ELS-Insttoken, this represents a institution token. If provided, this key (in combination with its associated APIKey) is used to establish the credentials needed to access content in this resource.
apiKey xsd:string Override for HTTP header X-ELS-APIKey, this represents a unique application developer key providing access to resource.
reqId xsd:string Override for HTTP header X-ELS-ReqId, this is a client-defined request identifier, which will be logged in all trace messages of the service. This identifier can be used to track a specific transaction in the service's message logs. Note that this should be a unique identifier for the client, and used to track a single transaction.
ver xsd:string Override for HTTP header X-ELS-ResourceVersion, this represents the version of the resource that should be received.
view xsd:string
default: META
options: META, META_ABS, META_ABS_REF, FULL, REF, ENTITLED


This alias represents the list of elements that will be returned in the response.



The following chart shows the Article Retrieval Views.
field xsd:string

This alias represents the name of specific fields that should be returned. The list of fields include all of the fields returned in the response payload (see view).

Multiple fields can be specified, delimited by commas.



ex. field=url,identifier,description
startref xsd:string

Applicable only to REF view. Numeric value representing the results offset (i.e. starting position for the resolved references).



ex. startref=5
refcount xsd:string

Applicable only to REF view. Numeric value representing the maximum number of resolved references to be returned. If not provided this will be set to a system default based on service level.



ex. refcount=10
xml-encode xsd:string
options: true, false


In XML and JSON response payloads, this retains the original mark-up as XML-encoded characters in response fields like dc:description.



ex. xml-encode=true
xml-decode xsd:string
options: true, false


In XML and JSON response payloads, this retains the original mark-up in response fields like dc:description.



ex. xml-decode=true
cdnRedirect xsd:string
default: false
options: true, false


For PDF documents setting this flag to true will result in being redirected to an Akamai version of the resource.

amsRedirect xsd:string
default: false
options: true, false


For PDF documents setting this flag to true will result in being redirected to the Author Manuscript version of the resource whenever the requestor is NOT entitled to the full content of the PDF.

responses
status:
200
representations
text/xml Article XML Response: This is XML representing the requested document. XML Example
status:
200
representations
application/json Article JSON Response: This is JSON representing the requested document. JSON Example
status:
200
representations
application/pdf Article PDF Response: This is a PDF representing the requested document.
status:
200
representations
application/png Article First Page PNG Response: This is a PNG image representing the first page of the requested document. PNG Example
status:
200
representations
application/rdf+xml Article RDF Response: This is RDF representing the requested document. RDF Example
status:
202
representations
text/xml Accepted: The request has been accepted for processing, but the processing has not been completed. This is typically returned if requesting an ePublication format requiring conversion processing.
status:
303
representations
See Other: This is redirect for a PDF document where the URL to the requested document is returned in the HTTP header field Location.
status:
307
representations
Temporary Redirect: This is redirect where the URL to the requested document is returned in the HTTP header field Location.
status:
400
representations
text/xml Invalid Request: This is an error that occurs when invalid information is submitted. Invalid Request Example
status:
401
representations
text/xml Authentication Error: This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (authtoken or APIKey). Authentication Error Example
status:
403
representations
text/xml Authorization/Entitlements Error: This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated. Authorization Error Example
status:
404
representations
text/xml Resource Not Found Error: This is an error that occurs when the requested resource cannot be found. Resource Not Found Example
status:
405
representations
text/xml Invalid HTTP Method: This is an error that occurs when the requested HTTP Method is invalid. Invalid Method Example
status:
406
representations
text/xml Invalid Mime Type: This is an error that occurs when the requested mime type is invalid. Invalid Mime Type Example
status:
429
representations
text/xml Quota Exceeded: This is an error that occurs when a requester has exceeded the quota limits associated with their API Key. Quota Exceeded Example
status:
500
representations
text/xml Generic Error: This is a general purpose error condition, typically due to back-end processing errors. Generic Error Example

https://api.elsevier.com/content/article/pii/{pii}

Article Retrieval API: This represents retrieval of a full text article by PII (Publication Item Identifier).

Methods
GET simple()

request
header params
Accept xsd:string
(required)
default: text/xml
options: text/xml, application/json, application/pdf, image/png, text/plain, application/rdf+xml
This represents the acceptable mime types in which the response can be generated. This can also be submitted as the query string parameter "httpAccept". This returns the response in JSON, ATOM, or XML mark-up.
Authorization xsd:string This header field contains the OAuth bearer access token in which the format of the field is "Bearer <token>" (where the token represents the end-user session key). The presence of a bearer token implies the request will be executed against user-based entitlements. The Authorization field overrides X-ELS-Authtoken.
X-ELS-APIKey xsd:string
(required)
This represents a unique application developer key providing access to API resources. This key can also be submitted as the query string parameter "apiKey"
X-ELS-Authtoken xsd:string This represents a end-user session. If provided, this token is used to validate the credentials needed to access content in this resource. This token can also be submitted through the HTTP header "Authorization" or the query string parameter "access_token".
X-ELS-Insttoken xsd:string This represents a institution token. If provided, this key (in combination with its associated APIKey) is used to establish the credentials needed to access content in this resource. This token can also be provided through the query string parameter "insttoken".
CR-Clickthrough-Client-Token xsd:string This Crossref standard extension header field contains a Crossref client token, which can be used in place of an API Key. This token can be used in conjunction with an authentication token or, if not provided, authentication will be accounted for through the IP address associated with the request. This replaces the old versions of the token CR-TDM-Client-Token and CR-Prospect-Client-Token. Additional information about use of Crossref and publishers can be found at Crossref Text and Data Mining"
CR-TDM-Client-Token xsd:string (Deprecated)This Crossref standard extension header field chas been replaced by CR-Clickthrough-Client-Token.
X-ELS-ReqId xsd:string This is a client-defined request identifier, which will be logged in all trace messages of the service. This identifier can be used to track a specific transaction in the service's message logs. It will also be returned as an HTTP header in the corresponding response. Note that this should be a unique identifier for the client, and used to track a single transaction.
X-ELS-ResourceVersion xsd:string
options: new
Represents the version of the resource that should be received. Note that submitting new always returns the latest response version.

query params
httpAccept xsd:string
options: text/xml, application/json, application/pdf, image/png, plain/text, application/rdf+xml
Override for HTTP header Accept, this represents the acceptable mime types for which the response can be generated.
access_token xsd:string Override for HTTP header Authorization, this contains the OAuth bearer access token, where the format of the field is "<token>" (where the token represents the end-user session key). The presence of a bearer token implies the request will be executed against user-based entitlements.
insttoken xsd:string Override for HTTP header X-ELS-Insttoken, this represents a institution token. If provided, this key (in combination with its associated APIKey) is used to establish the credentials needed to access content in this resource.
apiKey xsd:string Override for HTTP header X-ELS-APIKey, this represents a unique application developer key providing access to resource.
reqId xsd:string Override for HTTP header X-ELS-ReqId, this is a client-defined request identifier, which will be logged in all trace messages of the service. This identifier can be used to track a specific transaction in the service's message logs. Note that this should be a unique identifier for the client, and used to track a single transaction.
ver xsd:string Override for HTTP header X-ELS-ResourceVersion, this represents the version of the resource that should be received.
view xsd:string
default: META
options: META, META_ABS, META_ABS_REF, FULL, REF, ENTITLED


This alias represents the list of elements that will be returned in the response.



The following chart shows the Article Retrieval Views.
field xsd:string

This alias represents the name of specific fields that should be returned. The list of fields include all of the fields returned in the response payload (see view).

Multiple fields can be specified, delimited by commas.



ex. field=url,identifier,description
startref xsd:string

Applicable only to REF view. Numeric value representing the results offset (i.e. starting position for the resolved references).



ex. startref=5
refcount xsd:string

Applicable only to REF view. Numeric value representing the maximum number of resolved references to be returned. If not provided this will be set to a system default based on service level.



ex. refcount=10
xml-encode xsd:string
options: true, false


In XML and JSON response payloads, this retains the original mark-up as XML-encoded characters in response fields like dc:description.



ex. xml-encode=true
xml-decode xsd:string
options: true, false


In XML and JSON response payloads, this retains the original mark-up in response fields like dc:description.



ex. xml-decode=true
cdnRedirect xsd:string
default: false
options: true, false


For PDF documents setting this flag to true will result in being redirected to an Akamai version of the resource.

Note: when retrieving from Akamai using this parameter, a HTTP 303 redirect is issued with the Akamai URL in the Location header field. The redirected request MUST specify 'application/pdf' as the Accept mime type in order to succeed -- the query string field 'httpAccept' is not recognized.

amsRedirect xsd:string
default: false
options: true, false


For PDF documents setting this flag to true will result in being redirected to the Author Manuscript version of the resource whenever the requestor is NOT entitled to the full content of the PDF.

responses
status:
200
representations
text/xml Article XML Response: This is XML representing the requested document. XML Example
status:
200
representations
application/json Article JSON Response: This is JSON representing the requested document. JSON Example
status:
200
representations
application/pdf Article PDF Response: This is a PDF representing the requested document.
status:
200
representations
application/png Article First Page PNG Response: This is a PNG image representing the first page of the requested document. PNG Example
status:
200
representations
application/rdf+xml Article RDF Response: This is RDF representing the requested document. RDF Example
status:
202
representations
text/xml Accepted: The request has been accepted for processing, but the processing has not been completed. This is typically returned if requesting an ePublication format requiring conversion processing.
status:
303
representations
See Other: This is redirect for a PDF document where the URL to the requested document is returned in the HTTP header field Location.
status:
307
representations
Temporary Redirect: This is redirect where the URL to the requested document is returned in the HTTP header field Location.
status:
400
representations
text/xml Invalid Request: This is an error that occurs when invalid information is submitted. Invalid Request Example
status:
401
representations
text/xml Authentication Error: This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (authtoken or APIKey). Authentication Error Example
status:
403
representations
text/xml Authorization/Entitlements Error: This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated. Authorization Error Example
status:
404
representations
text/xml Resource Not Found Error: This is an error that occurs when the requested resource cannot be found. Resource Not Found Example
status:
405
representations
text/xml Invalid HTTP Method: This is an error that occurs when the requested HTTP Method is invalid. Invalid Method Example
status:
406
representations
text/xml Invalid Mime Type: This is an error that occurs when the requested mime type is invalid. Invalid Mime Type Example
status:
429
representations
text/xml Quota Exceeded: This is an error that occurs when a requester has exceeded the quota limits associated with their API Key. Quota Exceeded Example
status:
500
representations
text/xml Generic Error: This is a general purpose error condition, typically due to back-end processing errors. Generic Error Example

https://api.elsevier.com/content/article/eid/{eid}

Article Retrieval API: This represents retrieval of a full text article by EID (Electronic Identifier). This can either be the full-text article identifier or the corresponding Scopus abstract identifier.

Methods
GET simple()

request
header params
Accept xsd:string
(required)
default: text/xml
options: text/xml, application/json, application/pdf, image/png, text/plain, application/rdf+xml
This represents the acceptable mime types in which the response can be generated. This can also be submitted as the query string parameter "httpAccept". This returns the response in JSON, ATOM, or XML mark-up.
Authorization xsd:string This header field contains the OAuth bearer access token in which the format of the field is "Bearer <token>" (where the token represents the end-user session key). The presence of a bearer token implies the request will be executed against user-based entitlements. The Authorization field overrides X-ELS-Authtoken.
X-ELS-APIKey xsd:string
(required)
This represents a unique application developer key providing access to API resources. This key can also be submitted as the query string parameter "apiKey"
X-ELS-Authtoken xsd:string This represents a end-user session. If provided, this token is used to validate the credentials needed to access content in this resource. This token can also be submitted through the HTTP header "Authorization" or the query string parameter "access_token".
X-ELS-Insttoken xsd:string This represents a institution token. If provided, this key (in combination with its associated APIKey) is used to establish the credentials needed to access content in this resource. This token can also be provided through the query string parameter "insttoken".
CR-Clickthrough-Client-Token xsd:string This Crossref standard extension header field contains a Crossref client token, which can be used in place of an API Key. This token can be used in conjunction with an authentication token or, if not provided, authentication will be accounted for through the IP address associated with the request. This replaces the old versions of the token CR-TDM-Client-Token and CR-Prospect-Client-Token. Additional information about use of Crossref and publishers can be found at Crossref Text and Data Mining"
CR-TDM-Client-Token xsd:string (Deprecated)This Crossref standard extension header field chas been replaced by CR-Clickthrough-Client-Token.
X-ELS-ReqId xsd:string This is a client-defined request identifier, which will be logged in all trace messages of the service. This identifier can be used to track a specific transaction in the service's message logs. It will also be returned as an HTTP header in the corresponding response. Note that this should be a unique identifier for the client, and used to track a single transaction.
X-ELS-ResourceVersion xsd:string
options: new
Represents the version of the resource that should be received. Note that submitting new always returns the latest response version.

query params
httpAccept xsd:string
options: text/xml, application/json, application/pdf, image/png, plain/text, application/rdf+xml
Override for HTTP header Accept, this represents the acceptable mime types for which the response can be generated.
access_token xsd:string Override for HTTP header Authorization, this contains the OAuth bearer access token, where the format of the field is "<token>" (where the token represents the end-user session key). The presence of a bearer token implies the request will be executed against user-based entitlements.
insttoken xsd:string Override for HTTP header X-ELS-Insttoken, this represents a institution token. If provided, this key (in combination with its associated APIKey) is used to establish the credentials needed to access content in this resource.
apiKey xsd:string Override for HTTP header X-ELS-APIKey, this represents a unique application developer key providing access to resource.
reqId xsd:string Override for HTTP header X-ELS-ReqId, this is a client-defined request identifier, which will be logged in all trace messages of the service. This identifier can be used to track a specific transaction in the service's message logs. Note that this should be a unique identifier for the client, and used to track a single transaction.
ver xsd:string Override for HTTP header X-ELS-ResourceVersion, this represents the version of the resource that should be received.
view xsd:string
default: META
options: META, META_ABS, META_ABS_REF, FULL, REF, ENTITLED


This alias represents the list of elements that will be returned in the response.



The following chart shows the Article Retrieval Views.
field xsd:string

This alias represents the name of specific fields that should be returned. The list of fields include all of the fields returned in the response payload (see view).

Multiple fields can be specified, delimited by commas.



ex. field=url,identifier,description
startref xsd:string

Applicable only to REF view. Numeric value representing the results offset (i.e. starting position for the resolved references).



ex. startref=5
refcount xsd:string

Applicable only to REF view. Numeric value representing the maximum number of resolved references to be returned. If not provided this will be set to a system default based on service level.



ex. refcount=10
xml-encode xsd:string
options: true, false


In XML and JSON response payloads, this retains the original mark-up as XML-encoded characters in response fields like dc:description.



ex. xml-encode=true
xml-decode xsd:string
options: true, false


In XML and JSON response payloads, this retains the original mark-up in response fields like dc:description.



ex. xml-decode=true
cdnRedirect xsd:string
default: false
options: true, false


For PDF documents setting this flag to true will result in being redirected to an Akamai version of the resource.

amsRedirect xsd:string
default: false
options: true, false


For PDF documents setting this flag to true will result in being redirected to the Author Manuscript version of the resource whenever the requestor is NOT entitled to the full content of the PDF.

responses
status:
200
representations
text/xml Article XML Response: This is XML representing the requested document. XML Example
status:
200
representations
application/json Article JSON Response: This is JSON representing the requested document. JSON Example
status:
200
representations
application/pdf Article PDF Response: This is a PDF representing the requested document.
status:
200
representations
application/png Article First Page PNG Response: This is a PNG image representing the first page of the requested document. PNG Example
status:
200
representations
application/rdf+xml Article RDF Response: This is RDF representing the requested document. RDF Example
status:
202
representations
text/xml Accepted: The request has been accepted for processing, but the processing has not been completed. This is typically returned if requesting an ePublication format requiring conversion processing.
status:
303
representations
See Other: This is redirect for a PDF document where the URL to the requested document is returned in the HTTP header field Location.
status:
307
representations
Temporary Redirect: This is redirect where the URL to the requested document is returned in the HTTP header field Location.
status:
400
representations
text/xml Invalid Request: This is an error that occurs when invalid information is submitted. Invalid Request Example
status:
401
representations
text/xml Authentication Error: This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (authtoken or APIKey). Authentication Error Example
status:
403
representations
text/xml Authorization/Entitlements Error: This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated. Authorization Error Example
status:
404
representations
text/xml Resource Not Found Error: This is an error that occurs when the requested resource cannot be found. Resource Not Found Example
status:
405
representations
text/xml Invalid HTTP Method: This is an error that occurs when the requested HTTP Method is invalid. Invalid Method Example
status:
406
representations
text/xml Invalid Mime Type: This is an error that occurs when the requested mime type is invalid. Invalid Mime Type Example
status:
429
representations
text/xml Quota Exceeded: This is an error that occurs when a requester has exceeded the quota limits associated with their API Key. Quota Exceeded Example
status:
500
representations
text/xml Generic Error: This is a general purpose error condition, typically due to back-end processing errors. Generic Error Example

https://api.elsevier.com/content/article/scopus_id/{scopus_id}

Article Retrieval API: This represents retrieval of a full text article by Scopus ID.

Methods
GET simple()

request
header params
Accept xsd:string
(required)
default: text/xml
options: text/xml, application/json, application/pdf, image/png, text/plain, application/rdf+xml
This represents the acceptable mime types in which the response can be generated. This can also be submitted as the query string parameter "httpAccept". This returns the response in JSON, ATOM, or XML mark-up.
Authorization xsd:string This header field contains the OAuth bearer access token in which the format of the field is "Bearer <token>" (where the token represents the end-user session key). The presence of a bearer token implies the request will be executed against user-based entitlements. The Authorization field overrides X-ELS-Authtoken.
X-ELS-APIKey xsd:string
(required)
This represents a unique application developer key providing access to API resources. This key can also be submitted as the query string parameter "apiKey"
X-ELS-Authtoken xsd:string This represents a end-user session. If provided, this token is used to validate the credentials needed to access content in this resource. This token can also be submitted through the HTTP header "Authorization" or the query string parameter "access_token".
X-ELS-Insttoken xsd:string This represents a institution token. If provided, this key (in combination with its associated APIKey) is used to establish the credentials needed to access content in this resource. This token can also be provided through the query string parameter "insttoken".
CR-Clickthrough-Client-Token xsd:string This Crossref standard extension header field contains a Crossref client token, which can be used in place of an API Key. This token can be used in conjunction with an authentication token or, if not provided, authentication will be accounted for through the IP address associated with the request. This replaces the old versions of the token CR-TDM-Client-Token and CR-Prospect-Client-Token. Additional information about use of Crossref and publishers can be found at Crossref Text and Data Mining"
CR-TDM-Client-Token xsd:string (Deprecated)This Crossref standard extension header field chas been replaced by CR-Clickthrough-Client-Token.
X-ELS-ReqId xsd:string This is a client-defined request identifier, which will be logged in all trace messages of the service. This identifier can be used to track a specific transaction in the service's message logs. It will also be returned as an HTTP header in the corresponding response. Note that this should be a unique identifier for the client, and used to track a single transaction.
X-ELS-ResourceVersion xsd:string
options: new
Represents the version of the resource that should be received. Note that submitting new always returns the latest response version.

query params
httpAccept xsd:string
options: text/xml, application/json, application/pdf, image/png, plain/text, application/rdf+xml
Override for HTTP header Accept, this represents the acceptable mime types for which the response can be generated.
access_token xsd:string Override for HTTP header Authorization, this contains the OAuth bearer access token, where the format of the field is "<token>" (where the token represents the end-user session key). The presence of a bearer token implies the request will be executed against user-based entitlements.
insttoken xsd:string Override for HTTP header X-ELS-Insttoken, this represents a institution token. If provided, this key (in combination with its associated APIKey) is used to establish the credentials needed to access content in this resource.
apiKey xsd:string Override for HTTP header X-ELS-APIKey, this represents a unique application developer key providing access to resource.
reqId xsd:string Override for HTTP header X-ELS-ReqId, this is a client-defined request identifier, which will be logged in all trace messages of the service. This identifier can be used to track a specific transaction in the service's message logs. Note that this should be a unique identifier for the client, and used to track a single transaction.
ver xsd:string Override for HTTP header X-ELS-ResourceVersion, this represents the version of the resource that should be received.
view xsd:string
default: META
options: META, META_ABS, META_ABS_REF, FULL, REF, ENTITLED


This alias represents the list of elements that will be returned in the response.



The following chart shows the Article Retrieval Views.
field xsd:string

This alias represents the name of specific fields that should be returned. The list of fields include all of the fields returned in the response payload (see view).

Multiple fields can be specified, delimited by commas.



ex. field=url,identifier,description
startref xsd:string

Applicable only to REF view. Numeric value representing the results offset (i.e. starting position for the resolved references).



ex. startref=5
refcount xsd:string

Applicable only to REF view. Numeric value representing the maximum number of resolved references to be returned. If not provided this will be set to a system default based on service level.



ex. refcount=10
xml-encode xsd:string
options: true, false


In XML and JSON response payloads, this retains the original mark-up as XML-encoded characters in response fields like dc:description.



ex. xml-encode=true
xml-decode xsd:string
options: true, false


In XML and JSON response payloads, this retains the original mark-up in response fields like dc:description.



ex. xml-decode=true
cdnRedirect xsd:string
default: false
options: true, false


For PDF documents setting this flag to true will result in being redirected to an Akamai version of the resource.

Note: when retrieving from Akamai using this parameter, a HTTP 303 redirect is issued with the Akamai URL in the Location header field. The redirected request MUST specify 'application/pdf' as the Accept mime type in order to succeed -- the query string field 'httpAccept' is not recognized.

amsRedirect xsd:string
default: false
options: true, false


For PDF documents setting this flag to true will result in being redirected to the Author Manuscript version of the resource whenever the requestor is NOT entitled to the full content of the PDF.

responses
status:
200
representations
text/xml Article XML Response: This is XML representing the requested document. XML Example
status:
200
representations
application/json Article JSON Response: This is JSON representing the requested document. JSON Example
status:
200
representations
application/pdf Article PDF Response: This is a PDF representing the requested document.
status:
200
representations
application/png Article First Page PNG Response: This is a PNG image representing the first page of the requested document. PNG Example
status:
200
representations
application/rdf+xml Article RDF Response: This is RDF representing the requested document. RDF Example
status:
202
representations
text/xml Accepted: The request has been accepted for processing, but the processing has not been completed. This is typically returned if requesting an ePublication format requiring conversion processing.
status:
303
representations
See Other: This is redirect for a PDF document where the URL to the requested document is returned in the HTTP header field Location.
status:
307
representations
Temporary Redirect: This is redirect where the URL to the requested document is returned in the HTTP header field Location.
status:
400
representations
text/xml Invalid Request: This is an error that occurs when invalid information is submitted. Invalid Request Example
status:
401
representations
text/xml Authentication Error: This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (authtoken or APIKey). Authentication Error Example
status:
403
representations
text/xml Authorization/Entitlements Error: This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated. Authorization Error Example
status:
404
representations
text/xml Resource Not Found Error: This is an error that occurs when the requested resource cannot be found. Resource Not Found Example
status:
405
representations
text/xml Invalid HTTP Method: This is an error that occurs when the requested HTTP Method is invalid. Invalid Method Example
status:
406
representations
text/xml Invalid Mime Type: This is an error that occurs when the requested mime type is invalid. Invalid Mime Type Example
status:
429
representations
text/xml Quota Exceeded: This is an error that occurs when a requester has exceeded the quota limits associated with their API Key. Quota Exceeded Example
status:
500
representations
text/xml Generic Error: This is a general purpose error condition, typically due to back-end processing errors. Generic Error Example

https://api.elsevier.com/content/article/pubmed_id/{pubmed_id}

Article Retrieval API: This represents retrieval of a full text article by Pubmed ID (Medline ID).

Methods
GET simple()

request
header params
Accept xsd:string
(required)
default: text/xml
options: text/xml, application/json, application/pdf, image/png, text/plain, application/rdf+xml
This represents the acceptable mime types in which the response can be generated. This can also be submitted as the query string parameter "httpAccept". This returns the response in JSON, ATOM, or XML mark-up.
Authorization xsd:string This header field contains the OAuth bearer access token in which the format of the field is "Bearer <token>" (where the token represents the end-user session key). The presence of a bearer token implies the request will be executed against user-based entitlements. The Authorization field overrides X-ELS-Authtoken.
X-ELS-APIKey xsd:string
(required)
This represents a unique application developer key providing access to API resources. This key can also be submitted as the query string parameter "apiKey"
X-ELS-Authtoken xsd:string This represents a end-user session. If provided, this token is used to validate the credentials needed to access content in this resource. This token can also be submitted through the HTTP header "Authorization" or the query string parameter "access_token".
X-ELS-Insttoken xsd:string This represents a institution token. If provided, this key (in combination with its associated APIKey) is used to establish the credentials needed to access content in this resource. This token can also be provided through the query string parameter "insttoken".
CR-Clickthrough-Client-Token xsd:string This Crossref standard extension header field contains a Crossref client token, which can be used in place of an API Key. This token can be used in conjunction with an authentication token or, if not provided, authentication will be accounted for through the IP address associated with the request. This replaces the old versions of the token CR-TDM-Client-Token and CR-Prospect-Client-Token. Additional information about use of Crossref and publishers can be found at Crossref Text and Data Mining"
CR-TDM-Client-Token xsd:string (Deprecated)This Crossref standard extension header field chas been replaced by CR-Clickthrough-Client-Token.
X-ELS-ReqId xsd:string This is a client-defined request identifier, which will be logged in all trace messages of the service. This identifier can be used to track a specific transaction in the service's message logs. It will also be returned as an HTTP header in the corresponding response. Note that this should be a unique identifier for the client, and used to track a single transaction.
X-ELS-ResourceVersion xsd:string
options: new
Represents the version of the resource that should be received. Note that submitting new always returns the latest response version.

query params
httpAccept xsd:string
options: text/xml, application/json, application/pdf, image/png, plain/text, application/rdf+xml
Override for HTTP header Accept, this represents the acceptable mime types for which the response can be generated.
access_token xsd:string Override for HTTP header Authorization, this contains the OAuth bearer access token, where the format of the field is "<token>" (where the token represents the end-user session key). The presence of a bearer token implies the request will be executed against user-based entitlements.
insttoken xsd:string Override for HTTP header X-ELS-Insttoken, this represents a institution token. If provided, this key (in combination with its associated APIKey) is used to establish the credentials needed to access content in this resource.
apiKey xsd:string Override for HTTP header X-ELS-APIKey, this represents a unique application developer key providing access to resource.
reqId xsd:string Override for HTTP header X-ELS-ReqId, this is a client-defined request identifier, which will be logged in all trace messages of the service. This identifier can be used to track a specific transaction in the service's message logs. Note that this should be a unique identifier for the client, and used to track a single transaction.
ver xsd:string Override for HTTP header X-ELS-ResourceVersion, this represents the version of the resource that should be received.
view xsd:string
default: META
options: META, META_ABS, META_ABS_REF, FULL, REF, ENTITLED


This alias represents the list of elements that will be returned in the response.



The following chart shows the Article Retrieval Views.
field xsd:string

This alias represents the name of specific fields that should be returned. The list of fields include all of the fields returned in the response payload (see view).

Multiple fields can be specified, delimited by commas.



ex. field=url,identifier,description
startref xsd:string

Applicable only to REF view. Numeric value representing the results offset (i.e. starting position for the resolved references).



ex. startref=5
refcount xsd:string

Applicable only to REF view. Numeric value representing the maximum number of resolved references to be returned. If not provided this will be set to a system default based on service level.



ex. refcount=10
xml-encode xsd:string
options: true, false


In XML and JSON response payloads, this retains the original mark-up as XML-encoded characters in response fields like dc:description.



ex. xml-encode=true
xml-decode xsd:string
options: true, false


In XML and JSON response payloads, this retains the original mark-up in response fields like dc:description.



ex. xml-decode=true
cdnRedirect xsd:string
default: false
options: true, false


For PDF documents setting this flag to true will result in being redirected to an Akamai version of the resource.

Note: when retrieving from Akamai using this parameter, a HTTP 303 redirect is issued with the Akamai URL in the Location header field. The redirected request MUST specify 'application/pdf' as the Accept mime type in order to succeed -- the query string field 'httpAccept' is not recognized.

amsRedirect xsd:string
default: false
options: true, false


For PDF documents setting this flag to true will result in being redirected to the Author Manuscript version of the resource whenever the requestor is NOT entitled to the full content of the PDF.

responses
status:
200
representations
text/xml Article XML Response: This is XML representing the requested document. XML Example
status:
200
representations
application/json Article JSON Response: This is JSON representing the requested document. JSON Example
status:
200
representations
application/pdf Article PDF Response: This is a PDF representing the requested document.
status:
200
representations
application/png Article First Page PNG Response: This is a PNG image representing the first page of the requested document. PNG Example
status:
200
representations
application/rdf+xml Article RDF Response: This is RDF representing the requested document. RDF Example
status:
202
representations
text/xml Accepted: The request has been accepted for processing, but the processing has not been completed. This is typically returned if requesting an ePublication format requiring conversion processing.
status:
303
representations
See Other: This is redirect for a PDF document where the URL to the requested document is returned in the HTTP header field Location.
status:
307
representations
Temporary Redirect: This is redirect where the URL to the requested document is returned in the HTTP header field Location.
status:
400
representations
text/xml Invalid Request: This is an error that occurs when invalid information is submitted. Invalid Request Example
status:
401
representations
text/xml Authentication Error: This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (authtoken or APIKey). Authentication Error Example
status:
403
representations
text/xml Authorization/Entitlements Error: This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated. Authorization Error Example
status:
404
representations
text/xml Resource Not Found Error: This is an error that occurs when the requested resource cannot be found. Resource Not Found Example
status:
405
representations
text/xml Invalid HTTP Method: This is an error that occurs when the requested HTTP Method is invalid. Invalid Method Example
status:
406
representations
text/xml Invalid Mime Type: This is an error that occurs when the requested mime type is invalid. Invalid Mime Type Example
status:
429
representations
text/xml Quota Exceeded: This is an error that occurs when a requester has exceeded the quota limits associated with their API Key. Quota Exceeded Example
status:
500
representations
text/xml Generic Error: This is a general purpose error condition, typically due to back-end processing errors. Generic Error Example