Object Retrieval API
These interfaces represent retrieval of objects associated with a full text article.
This resource can also return reference details for an individual object or an entire
full text article. The reference metadata response will contain links to the associated
Full-Text article.
The following chart shows the Object Retrieval Views.
Summary
| Resource |
Method |
Description |
| https://api.elsevier.com/content/object/doi/{doi} |
GET
|
Object Retrieval API:
This represents retrieval of object references associated with a full text article by DOI (Document Object Identifier).
|
|
|
|
| https://api.elsevier.com/content/object/pii/{pii} |
GET
|
Object Retrieval API:
This represents retrieval of object references associated with a full text article by PII (Publication Item Identifier).
|
|
|
|
| https://api.elsevier.com/content/object/scopus_id/{scopus_id} |
GET
|
Object Retrieval API:
This represents retrieval of object references associated with a full text article by Scopus ID.
|
|
|
|
| https://api.elsevier.com/content/object/pubmed_id/{pubmed_id} |
GET
|
Object Retrieval API:
This represents retrieval of object references associated with a full text article by Pubmed ID (Medline ID).
|
|
|
|
| https://api.elsevier.com/content/object/pii/{pii}/ref/{ref} |
GET
|
Object Retrieval API:
This represents retrieval of a specific object associated with a full text article, identified by PII (Publication Item Identifier). When specifying a view and a supported mime type (XML,
JSON, or RDF), the object metadata will be returned instead of the object itself.
|
|
|
|
| https://api.elsevier.com/content/object/doi/{doi}/ref/{ref} |
GET
|
Object Retrieval API:
This represents retrieval of a specific object associated with a full text article, identified by DOI (Document Object Identifier). When specifying a view and a supported mime type (XML,
JSON, or RDF), the object metadata will be returned instead of the object itself.
|
|
|
|
| https://api.elsevier.com/content/object/scopus_id/{scopus_id}/ref/{ref} |
GET
|
Object Retrieval API:
This represents retrieval of a specific object associated with a full text article, identified by Scopus ID. When specifying a view and a supported mime type (XML, JSON, or RDF), the object
metadata will be returned instead of the object itself.
|
|
|
|
| https://api.elsevier.com/content/object/pubmed_id/{pubmed_id}/ref/{ref} |
GET
|
Object Retrieval API:
This represents retrieval of a specific object associated with a full text article, identified by Pubmed ID (Medline ID). When specifying a view and a supported mime type (XML, JSON, or RDF),
the object metadata will be returned instead of the object itself.
|
|
|
|
| https://api.elsevier.com/content/object/eid/{eid} |
GET
|
Object Retrieval API:
This represents retrieval of a specific object associated with a full text article, identified by EID (Electronic Identifier). When specifying a view and a supported mime type (XML, JSON,
or RDF), the object metadata will be returned instead of the object itself.
|
|
|
|
| https://api.elsevier.com/content/object/pii/{pii}/ref/{ref}/thumbnail |
GET
|
Object Retrieval API:
This represents retrieval of a thumbnail image associated with the document reference (PII).
|
|
|
|
| https://api.elsevier.com/content/object/doi/{doi}/ref/{ref}/thumbnail |
GET
|
Object Retrieval API:
This represents retrieval of a thumbnail image associated with the document reference (DOI).
|
|
|
|
| https://api.elsevier.com/content/object/scopus_id/{scopus_id}/ref/{ref}/thumbnail |
GET
|
Object Retrieval API:
This represents retrieval of a thumbnail image associated with the document reference (Scopus ID).
|
|
|
|
| https://api.elsevier.com/content/object/pubmed_id/{pubmed_id}/ref/{ref}/thumbnail |
GET
|
Object Retrieval API:
This represents retrieval of a thumbnail image associated with the document reference (Pubmed ID).
|
|
|
|
| https://api.elsevier.com/content/object/pii/{pii}/ref/{ref}/standard |
GET
|
Object Retrieval API:
This represents retrieval of a regular-sized image associated with the document reference (PII).
|
|
|
|
| https://api.elsevier.com/content/object/doi/{doi}/ref/{ref}/standard |
GET
|
Object Retrieval API:
This represents retrieval of a regular-sized image associated with the document reference (DOI).
|
|
|
|
| https://api.elsevier.com/content/object/scopus_id/{scopus_id}/ref/{ref}/standard |
GET
|
Object Retrieval API:
This represents retrieval of a regular-sized image associated with the document reference (Scopus ID).
|
|
|
|
| https://api.elsevier.com/content/object/pubmed_id/{pubmed_id}/ref/{ref}/standard |
GET
|
Object Retrieval API:
This represents retrieval of a regular-sized image associated with the document reference (Pubmed ID).
|
|
|
|
| https://api.elsevier.com/content/object/pii/{pii}/ref/{ref}/high |
GET
|
Object Retrieval API:
This represents retrieval of a high-resolution image associated with the document reference (PII).
|
|
|
|
| https://api.elsevier.com/content/object/doi/{doi}/ref/{ref}/high |
GET
|
Object Retrieval API:
This represents retrieval of a high-resolution image associated with the document reference (DOI).
|
|
|
|
| https://api.elsevier.com/content/object/scopus_id/{scopus_id}/ref/{ref}/high |
GET
|
Object Retrieval API:
This represents retrieval of a high-resolution image associated with the document reference (Scopus ID).
|
|
|
|
| https://api.elsevier.com/content/object/pubmed_id/{pubmed_id}/ref/{ref}/high |
GET
|
Object Retrieval API:
This represents retrieval of a high-resolution image associated with the document reference (Pubmed ID).
|
Resources
Object Retrieval API:
This represents retrieval of object references associated with a full text article by DOI (Document Object Identifier).
Methods
request
header params
| Accept |
xsd:string
(required)
default: text/xml
options:
text/xml, application/json, 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".
|
| 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 |
Represents the version of the resource that should be received.
|
query params
| httpAccept |
xsd:string
options:
text/xml, application/json, 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: STANDARD
options:
META |
META - This alias represents the object metadata associated with the document. This
can represent a single object reference or all objects associated with a document,
depending upon the resource identifier.
The following chart shows the Object 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.Note that this implies the metadata
of an object will be returned.
ex. field=url,identifier,description
|
responses
status:
200
representations
| text/xml |
Object Metadata XML Response:
This is XML representing the requested document.
|
XML Metadata Sample |
status:
200
representations
| application/json |
Object Metadata JSON Response:
This is JSON representing the requested document.
|
JSON Metadata Sample |
status:
200
representations
| application/rdf+xml |
Object Metadata RDF Response:
This is RDF representing the requested document.
|
RDF Metadata Sample |
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
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 |
Object Retrieval API:
This represents retrieval of object references associated with a full text article by PII (Publication Item Identifier).
Methods
request
header params
| Accept |
xsd:string
(required)
default: text/xml
options:
text/xml, application/json, 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".
|
| 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 |
Represents the version of the resource that should be received.
|
query params
| httpAccept |
xsd:string
options:
text/xml, application/json, 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: STANDARD
options:
META |
META - This alias represents the object metadata associated with the document. This
can represent a single object reference or all objects associated with a document,
depending upon the resource identifier.
The following chart shows the Object 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.Note that this implies the metadata
of an object will be returned.
ex. field=url,identifier,description
|
responses
status:
200
representations
| text/xml |
Object Metadata XML Response:
This is XML representing the requested document.
|
XML Metadata Sample |
status:
200
representations
| application/json |
Object Metadata JSON Response:
This is JSON representing the requested document.
|
JSON Metadata Sample |
status:
200
representations
| application/rdf+xml |
Object Metadata RDF Response:
This is RDF representing the requested document.
|
RDF Metadata Sample |
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
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 |
Object Retrieval API:
This represents retrieval of object references associated with a full text article by Scopus ID.
Methods
request
header params
| Accept |
xsd:string
(required)
default: text/xml
options:
text/xml, application/json, 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".
|
| 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 |
Represents the version of the resource that should be received.
|
query params
| httpAccept |
xsd:string
options:
text/xml, application/json, 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: STANDARD
options:
META |
META - This alias represents the object metadata associated with the document. This
can represent a single object reference or all objects associated with a document,
depending upon the resource identifier.
The following chart shows the Object 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.Note that this implies the metadata
of an object will be returned.
ex. field=url,identifier,description
|
responses
status:
200
representations
| text/xml |
Object Metadata XML Response:
This is XML representing the requested document.
|
XML Metadata Sample |
status:
200
representations
| application/json |
Object Metadata JSON Response:
This is JSON representing the requested document.
|
JSON Metadata Sample |
status:
200
representations
| application/rdf+xml |
Object Metadata RDF Response:
This is RDF representing the requested document.
|
RDF Metadata Sample |
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
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 |
Object Retrieval API:
This represents retrieval of object references associated with a full text article by Pubmed ID (Medline ID).
Methods
request
header params
| Accept |
xsd:string
(required)
default: text/xml
options:
text/xml, application/json, 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".
|
| 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 |
Represents the version of the resource that should be received.
|
query params
| httpAccept |
xsd:string
options:
text/xml, application/json, 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: STANDARD
options:
META |
META - This alias represents the object metadata associated with the document. This
can represent a single object reference or all objects associated with a document,
depending upon the resource identifier.
The following chart shows the Object 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.Note that this implies the metadata
of an object will be returned.
ex. field=url,identifier,description
|
responses
status:
200
representations
| text/xml |
Object Metadata XML Response:
This is XML representing the requested document.
|
XML Metadata Sample |
status:
200
representations
| application/json |
Object Metadata JSON Response:
This is JSON representing the requested document.
|
JSON Metadata Sample |
status:
200
representations
| application/rdf+xml |
Object Metadata RDF Response:
This is RDF representing the requested document.
|
RDF Metadata Sample |
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
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 |
Object Retrieval API:
This represents retrieval of a specific object associated with a full text article, identified by PII (Publication Item Identifier). When specifying a view and a supported mime type (XML,
JSON, or RDF), the object metadata will be returned instead of the object itself.
Methods
request
header params
| Accept |
xsd:string
(required)
default: */*
options:
text/xml, application/pdf, image/jpeg, image/gif, image/png, image/svg, image/tiff, application/vnd.ms-excel, application/postscript, text/mathml, application/excel, application/ppt, application/word, text/plain, application/rtf, video/avi, video/x-flv, audio/mp3, video/mpeg, video/mpeg4, video/quicktime, application/x-tar, application/zip, application/vnd.google-earth.kml+xml, application/vnd.google-earth.kmz |
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".
|
| 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 |
Represents the version of the resource that should be received.
|
query params
| httpAccept |
xsd:string
options:
text/xml, application/pdf, image/jpeg, image/gif, image/png, image/svg, image/tiff, application/vnd.ms-excel, application/postscript, text/mathml, application/excel, application/ppt, application/word, text/plain, application/rtf, video/avi, video/x-flv, audio/mp3, video/mpeg, video/mpeg4, video/quicktime, application/x-tar, application/zip, application/vnd.google-earth.kml+xml, application/vnd.google-earth.kmz |
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: STANDARD
options:
META, THUMBNAIL, STANDARD, HIGH |
META - This alias represents the object metadata associated with the document. This
can represent a single object reference or all objects associated with a document,
depending upon the resource identifier.
The following chart shows the Object Retrieval META View.
THUMBNAIL - This returns the smallest version of the object, if image
STANDARD - This returns the attachment or, if image, the regular form of the image
HIGH - This returns the highest resolution form of the object, if image
|
| 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.Note that this implies the metadata
of an object will be returned.
ex. field=url,identifier,description
|
responses
status:
200
representations
| text/xml |
Object Metadata XML Response:
This is XML representing the requested document.
|
XML Metadata Sample |
status:
200
representations
| application/json |
Object Metadata JSON Response:
This is JSON representing the requested document.
|
JSON Metadata Sample |
status:
200
representations
| application/rdf+xml |
Object Metadata RDF Response:
This is RDF representing the requested document.
|
RDF Metadata Sample |
status:
200
representations
| application/pdf |
Object Response:
This is PDF representing the requested object.
|
|
status:
200
representations
| image/jpeg |
Object Response:
This is JPG image file representing the requested object.
|
|
status:
200
representations
| image/gif |
Object Response:
This is GIF image file representing the requested object.
|
|
status:
200
representations
| image/png |
Object Response:
This is Portable Network Graphics file representing the requested object.
|
|
status:
200
representations
| image/svg |
Object Response:
This is Scalable Vector Graphics file representing the requested object.
|
|
status:
200
representations
| image/tiff |
Object Response:
This is TIFF image file representing the requested object.
|
|
status:
200
representations
| application/vnd.ms-excel |
Object Response:
This is Comma Separated Value file representing the requested object.
|
|
status:
200
representations
| application/postscript |
Object Response:
This is Encapsulated PostScript representing the requested object.
|
|
status:
200
representations
| text/mathml |
Object Response:
This is MathML file representing the requested object.
|
|
status:
200
representations
| application/excel |
Object Response:
This is Microsoft Excel file representing the requested object.
|
|
status:
200
representations
| application/ppt |
Object Response:
This is Microsoft Powerpoint file representing the requested object.
|
|
status:
200
representations
| application/word |
Object Response:
This is Microsoft Word file representing the requested object.
|
|
status:
200
representations
| text/plain |
Object Response:
This is Plain text file representing the requested object.
|
|
status:
200
representations
| application/rtf |
Object Response:
This is Rich Text Format file representing the requested object.
|
|
status:
200
representations
| video/avi |
Object Response:
This is AVI movie representing the requested object.
|
|
status:
200
representations
| video/x-flv |
Object Response:
This is Flash Video file representing the requested object.
|
|
status:
200
representations
| audio/mp3 |
Object Response:
This is MP3 audio file representing the requested object.
|
|
status:
200
representations
| video/mpeg |
Object Response:
This is MPEG movie representing the requested object.
|
|
status:
200
representations
| video/mpeg4 |
Object Response:
This is MPEG-4 movie representing the requested object.
|
|
status:
200
representations
| video/quicktime |
Object Response:
This is Quicktime movie representing the requested object.
|
|
status:
200
representations
| application/x-tar |
Object Response:
This is TAR file representing the requested object.
|
|
status:
200
representations
| application/zip |
Object Response:
This is ZIP file representing the requested object.
|
|
status:
200
representations
| application/vnd.google-earth.kml+xml |
Object Response:
This is Google Earth KML+XML file representing the requested object.
|
|
status:
200
representations
| application/vnd.google-earth.kmz |
Object Response:
This is Google Earth ZIP file representing the requested object.
|
|
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
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 |
Object Retrieval API:
This represents retrieval of a specific object associated with a full text article, identified by DOI (Document Object Identifier). When specifying a view and a supported mime type (XML,
JSON, or RDF), the object metadata will be returned instead of the object itself.
Methods
request
header params
| Accept |
xsd:string
(required)
default: */*
options:
text/xml, application/pdf, image/jpeg, image/gif, image/png, image/svg, image/tiff, application/vnd.ms-excel, application/postscript, text/mathml, application/excel, application/ppt, application/word, text/plain, application/rtf, video/avi, video/x-flv, audio/mp3, video/mpeg, video/mpeg4, video/quicktime, application/x-tar, application/zip, application/vnd.google-earth.kml+xml, application/vnd.google-earth.kmz |
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".
|
| 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 |
Represents the version of the resource that should be received.
|
query params
| httpAccept |
xsd:string
options:
text/xml, application/pdf, image/jpeg, image/gif, image/png, image/svg, image/tiff, application/vnd.ms-excel, application/postscript, text/mathml, application/excel, application/ppt, application/word, text/plain, application/rtf, video/avi, video/x-flv, audio/mp3, video/mpeg, video/mpeg4, video/quicktime, application/x-tar, application/zip, application/vnd.google-earth.kml+xml, application/vnd.google-earth.kmz |
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: STANDARD
options:
META, THUMBNAIL, STANDARD, HIGH |
META - This alias represents the object metadata associated with the document. This
can represent a single object reference or all objects associated with a document,
depending upon the resource identifier.
The following chart shows the Object Retrieval META View.
THUMBNAIL - This returns the smallest version of the object, if image
STANDARD - This returns the attachment or, if image, the regular form of the image
HIGH - This returns the highest resolution form of the object, if image
|
| 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.Note that this implies the metadata
of an object will be returned.
ex. field=url,identifier,description
|
responses
status:
200
representations
| text/xml |
Object Metadata XML Response:
This is XML representing the requested document.
|
XML Metadata Sample |
status:
200
representations
| application/json |
Object Metadata JSON Response:
This is JSON representing the requested document.
|
JSON Metadata Sample |
status:
200
representations
| application/rdf+xml |
Object Metadata RDF Response:
This is RDF representing the requested document.
|
RDF Metadata Sample |
status:
200
representations
| application/pdf |
Object Response:
This is PDF representing the requested object.
|
|
status:
200
representations
| image/jpeg |
Object Response:
This is JPG image file representing the requested object.
|
|
status:
200
representations
| image/gif |
Object Response:
This is GIF image file representing the requested object.
|
|
status:
200
representations
| image/png |
Object Response:
This is Portable Network Graphics file representing the requested object.
|
|
status:
200
representations
| image/svg |
Object Response:
This is Scalable Vector Graphics file representing the requested object.
|
|
status:
200
representations
| image/tiff |
Object Response:
This is TIFF image file representing the requested object.
|
|
status:
200
representations
| application/vnd.ms-excel |
Object Response:
This is Comma Separated Value file representing the requested object.
|
|
status:
200
representations
| application/postscript |
Object Response:
This is Encapsulated PostScript representing the requested object.
|
|
status:
200
representations
| text/mathml |
Object Response:
This is MathML file representing the requested object.
|
|
status:
200
representations
| application/excel |
Object Response:
This is Microsoft Excel file representing the requested object.
|
|
status:
200
representations
| application/ppt |
Object Response:
This is Microsoft Powerpoint file representing the requested object.
|
|
status:
200
representations
| application/word |
Object Response:
This is Microsoft Word file representing the requested object.
|
|
status:
200
representations
| text/plain |
Object Response:
This is Plain text file representing the requested object.
|
|
status:
200
representations
| application/rtf |
Object Response:
This is Rich Text Format file representing the requested object.
|
|
status:
200
representations
| video/avi |
Object Response:
This is AVI movie representing the requested object.
|
|
status:
200
representations
| video/x-flv |
Object Response:
This is Flash Video file representing the requested object.
|
|
status:
200
representations
| audio/mp3 |
Object Response:
This is MP3 audio file representing the requested object.
|
|
status:
200
representations
| video/mpeg |
Object Response:
This is MPEG movie representing the requested object.
|
|
status:
200
representations
| video/mpeg4 |
Object Response:
This is MPEG-4 movie representing the requested object.
|
|
status:
200
representations
| video/quicktime |
Object Response:
This is Quicktime movie representing the requested object.
|
|
status:
200
representations
| application/x-tar |
Object Response:
This is TAR file representing the requested object.
|
|
status:
200
representations
| application/zip |
Object Response:
This is ZIP file representing the requested object.
|
|
status:
200
representations
| application/vnd.google-earth.kml+xml |
Object Response:
This is Google Earth KML+XML file representing the requested object.
|
|
status:
200
representations
| application/vnd.google-earth.kmz |
Object Response:
This is Google Earth ZIP file representing the requested object.
|
|
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
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 |
Object Retrieval API:
This represents retrieval of a specific object associated with a full text article, identified by Scopus ID. When specifying a view and a supported mime type (XML, JSON, or RDF), the object
metadata will be returned instead of the object itself.
Methods
request
header params
| Accept |
xsd:string
(required)
default: */*
options:
text/xml, application/pdf, image/jpeg, image/gif, image/png, image/svg, image/tiff, application/vnd.ms-excel, application/postscript, text/mathml, application/excel, application/ppt, application/word, text/plain, application/rtf, video/avi, video/x-flv, audio/mp3, video/mpeg, video/mpeg4, video/quicktime, application/x-tar, application/zip, application/vnd.google-earth.kml+xml, application/vnd.google-earth.kmz |
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".
|
| 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 |
Represents the version of the resource that should be received.
|
query params
| httpAccept |
xsd:string
options:
text/xml, application/pdf, image/jpeg, image/gif, image/png, image/svg, image/tiff, application/vnd.ms-excel, application/postscript, text/mathml, application/excel, application/ppt, application/word, text/plain, application/rtf, video/avi, video/x-flv, audio/mp3, video/mpeg, video/mpeg4, video/quicktime, application/x-tar, application/zip, application/vnd.google-earth.kml+xml, application/vnd.google-earth.kmz |
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: STANDARD
options:
META, THUMBNAIL, STANDARD, HIGH |
META - This alias represents the object metadata associated with the document. This
can represent a single object reference or all objects associated with a document,
depending upon the resource identifier.
The following chart shows the Object Retrieval META View.
THUMBNAIL - This returns the smallest version of the object, if image
STANDARD - This returns the attachment or, if image, the regular form of the image
HIGH - This returns the highest resolution form of the object, if image
|
| 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.Note that this implies the metadata
of an object will be returned.
ex. field=url,identifier,description
|
responses
status:
200
representations
| text/xml |
Object Metadata XML Response:
This is XML representing the requested document.
|
XML Metadata Sample |
status:
200
representations
| application/json |
Object Metadata JSON Response:
This is JSON representing the requested document.
|
JSON Metadata Sample |
status:
200
representations
| application/rdf+xml |
Object Metadata RDF Response:
This is RDF representing the requested document.
|
RDF Metadata Sample |
status:
200
representations
| application/pdf |
Object Response:
This is PDF representing the requested object.
|
|
status:
200
representations
| image/jpeg |
Object Response:
This is JPG image file representing the requested object.
|
|
status:
200
representations
| image/gif |
Object Response:
This is GIF image file representing the requested object.
|
|
status:
200
representations
| image/png |
Object Response:
This is Portable Network Graphics file representing the requested object.
|
|
status:
200
representations
| image/svg |
Object Response:
This is Scalable Vector Graphics file representing the requested object.
|
|
status:
200
representations
| image/tiff |
Object Response:
This is TIFF image file representing the requested object.
|
|
status:
200
representations
| application/vnd.ms-excel |
Object Response:
This is Comma Separated Value file representing the requested object.
|
|
status:
200
representations
| application/postscript |
Object Response:
This is Encapsulated PostScript representing the requested object.
|
|
status:
200
representations
| text/mathml |
Object Response:
This is MathML file representing the requested object.
|
|
status:
200
representations
| application/excel |
Object Response:
This is Microsoft Excel file representing the requested object.
|
|
status:
200
representations
| application/ppt |
Object Response:
This is Microsoft Powerpoint file representing the requested object.
|
|
status:
200
representations
| application/word |
Object Response:
This is Microsoft Word file representing the requested object.
|
|
status:
200
representations
| text/plain |
Object Response:
This is Plain text file representing the requested object.
|
|
status:
200
representations
| application/rtf |
Object Response:
This is Rich Text Format file representing the requested object.
|
|
status:
200
representations
| video/avi |
Object Response:
This is AVI movie representing the requested object.
|
|
status:
200
representations
| video/x-flv |
Object Response:
This is Flash Video file representing the requested object.
|
|
status:
200
representations
| audio/mp3 |
Object Response:
This is MP3 audio file representing the requested object.
|
|
status:
200
representations
| video/mpeg |
Object Response:
This is MPEG movie representing the requested object.
|
|
status:
200
representations
| video/mpeg4 |
Object Response:
This is MPEG-4 movie representing the requested object.
|
|
status:
200
representations
| video/quicktime |
Object Response:
This is Quicktime movie representing the requested object.
|
|
status:
200
representations
| application/x-tar |
Object Response:
This is TAR file representing the requested object.
|
|
status:
200
representations
| application/zip |
Object Response:
This is ZIP file representing the requested object.
|
|
status:
200
representations
| application/vnd.google-earth.kml+xml |
Object Response:
This is Google Earth KML+XML file representing the requested object.
|
|
status:
200
representations
| application/vnd.google-earth.kmz |
Object Response:
This is Google Earth ZIP file representing the requested object.
|
|
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
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 |
Object Retrieval API:
This represents retrieval of a specific object associated with a full text article, identified by Pubmed ID (Medline ID). When specifying a view and a supported mime type (XML, JSON, or RDF),
the object metadata will be returned instead of the object itself.
Methods
request
header params
| Accept |
xsd:string
(required)
default: */*
options:
text/xml, application/pdf, image/jpeg, image/gif, image/png, image/svg, image/tiff, application/vnd.ms-excel, application/postscript, text/mathml, application/excel, application/ppt, application/word, text/plain, application/rtf, video/avi, video/x-flv, audio/mp3, video/mpeg, video/mpeg4, video/quicktime, application/x-tar, application/zip, application/vnd.google-earth.kml+xml, application/vnd.google-earth.kmz |
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".
|
| 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 |
Represents the version of the resource that should be received.
|
query params
| httpAccept |
xsd:string
options:
text/xml, application/pdf, image/jpeg, image/gif, image/png, image/svg, image/tiff, application/vnd.ms-excel, application/postscript, text/mathml, application/excel, application/ppt, application/word, text/plain, application/rtf, video/avi, video/x-flv, audio/mp3, video/mpeg, video/mpeg4, video/quicktime, application/x-tar, application/zip, application/vnd.google-earth.kml+xml, application/vnd.google-earth.kmz |
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: STANDARD
options:
META, THUMBNAIL, STANDARD, HIGH |
META - This alias represents the object metadata associated with the document. This
can represent a single object reference or all objects associated with a document,
depending upon the resource identifier.
The following chart shows the Object Retrieval META View.
THUMBNAIL - This returns the smallest version of the object, if image
STANDARD - This returns the attachment or, if image, the regular form of the image
HIGH - This returns the highest resolution form of the object, if image
|
| 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.Note that this implies the metadata
of an object will be returned.
ex. field=url,identifier,description
|
responses
status:
200
representations
| text/xml |
Object Metadata XML Response:
This is XML representing the requested document.
|
XML Metadata Sample |
status:
200
representations
| application/json |
Object Metadata JSON Response:
This is JSON representing the requested document.
|
JSON Metadata Sample |
status:
200
representations
| application/rdf+xml |
Object Metadata RDF Response:
This is RDF representing the requested document.
|
RDF Metadata Sample |
status:
200
representations
| application/pdf |
Object Response:
This is PDF representing the requested object.
|
|
status:
200
representations
| image/jpeg |
Object Response:
This is JPG image file representing the requested object.
|
|
status:
200
representations
| image/gif |
Object Response:
This is GIF image file representing the requested object.
|
|
status:
200
representations
| image/png |
Object Response:
This is Portable Network Graphics file representing the requested object.
|
|
status:
200
representations
| image/svg |
Object Response:
This is Scalable Vector Graphics file representing the requested object.
|
|
status:
200
representations
| image/tiff |
Object Response:
This is TIFF image file representing the requested object.
|
|
status:
200
representations
| application/vnd.ms-excel |
Object Response:
This is Comma Separated Value file representing the requested object.
|
|
status:
200
representations
| application/postscript |
Object Response:
This is Encapsulated PostScript representing the requested object.
|
|
status:
200
representations
| text/mathml |
Object Response:
This is MathML file representing the requested object.
|
|
status:
200
representations
| application/excel |
Object Response:
This is Microsoft Excel file representing the requested object.
|
|
status:
200
representations
| application/ppt |
Object Response:
This is Microsoft Powerpoint file representing the requested object.
|
|
status:
200
representations
| application/word |
Object Response:
This is Microsoft Word file representing the requested object.
|
|
status:
200
representations
| text/plain |
Object Response:
This is Plain text file representing the requested object.
|
|
status:
200
representations
| application/rtf |
Object Response:
This is Rich Text Format file representing the requested object.
|
|
status:
200
representations
| video/avi |
Object Response:
This is AVI movie representing the requested object.
|
|
status:
200
representations
| video/x-flv |
Object Response:
This is Flash Video file representing the requested object.
|
|
status:
200
representations
| audio/mp3 |
Object Response:
This is MP3 audio file representing the requested object.
|
|
status:
200
representations
| video/mpeg |
Object Response:
This is MPEG movie representing the requested object.
|
|
status:
200
representations
| video/mpeg4 |
Object Response:
This is MPEG-4 movie representing the requested object.
|
|
status:
200
representations
| video/quicktime |
Object Response:
This is Quicktime movie representing the requested object.
|
|
status:
200
representations
| application/x-tar |
Object Response:
This is TAR file representing the requested object.
|
|
status:
200
representations
| application/zip |
Object Response:
This is ZIP file representing the requested object.
|
|
status:
200
representations
| application/vnd.google-earth.kml+xml |
Object Response:
This is Google Earth KML+XML file representing the requested object.
|
|
status:
200
representations
| application/vnd.google-earth.kmz |
Object Response:
This is Google Earth ZIP file representing the requested object.
|
|
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
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 |
Object Retrieval API:
This represents retrieval of a specific object associated with a full text article, identified by EID (Electronic Identifier). When specifying a view and a supported mime type (XML, JSON,
or RDF), the object metadata will be returned instead of the object itself.
Methods
request
header params
| Accept |
xsd:string
(required)
default: */*
options:
text/xml, application/pdf, image/jpeg, image/gif, image/png, image/svg, image/tiff, application/vnd.ms-excel, application/postscript, text/mathml, application/excel, application/ppt, application/word, text/plain, application/rtf, video/avi, video/x-flv, audio/mp3, video/mpeg, video/mpeg4, video/quicktime, application/x-tar, application/zip, application/vnd.google-earth.kml+xml, application/vnd.google-earth.kmz |
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".
|
| 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 |
Represents the version of the resource that should be received.
|
query params
| httpAccept |
xsd:string
options:
text/xml, application/pdf, image/jpeg, image/gif, image/png, image/svg, image/tiff, application/vnd.ms-excel, application/postscript, text/mathml, application/excel, application/ppt, application/word, text/plain, application/rtf, video/avi, video/x-flv, audio/mp3, video/mpeg, video/mpeg4, video/quicktime, application/x-tar, application/zip, application/vnd.google-earth.kml+xml, application/vnd.google-earth.kmz |
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: STANDARD
options:
META, THUMBNAIL, STANDARD, HIGH |
META - This alias represents the object metadata associated with the document. This
can represent a single object reference or all objects associated with a document,
depending upon the resource identifier.
The following chart shows the Object Retrieval META View.
THUMBNAIL - This returns the smallest version of the object, if image
STANDARD - This returns the attachment or, if image, the regular form of the image
HIGH - This returns the highest resolution form of the object, if image
|
| 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.Note that this implies the metadata
of an object will be returned.
ex. field=url,identifier,description
|
responses
status:
200
representations
| text/xml |
Object Metadata XML Response:
This is XML representing the requested document.
|
XML Metadata Sample |
status:
200
representations
| application/json |
Object Metadata JSON Response:
This is JSON representing the requested document.
|
JSON Metadata Sample |
status:
200
representations
| application/rdf+xml |
Object Metadata RDF Response:
This is RDF representing the requested document.
|
RDF Metadata Sample |
status:
200
representations
| application/pdf |
Object Response:
This is PDF representing the requested object.
|
|
status:
200
representations
| image/jpeg |
Object Response:
This is JPG image file representing the requested object.
|
|
status:
200
representations
| image/gif |
Object Response:
This is GIF image file representing the requested object.
|
|
status:
200
representations
| image/png |
Object Response:
This is Portable Network Graphics file representing the requested object.
|
|
status:
200
representations
| image/svg |
Object Response:
This is Scalable Vector Graphics file representing the requested object.
|
|
status:
200
representations
| image/tiff |
Object Response:
This is TIFF image file representing the requested object.
|
|
status:
200
representations
| application/vnd.ms-excel |
Object Response:
This is Comma Separated Value file representing the requested object.
|
|
status:
200
representations
| application/postscript |
Object Response:
This is Encapsulated PostScript representing the requested object.
|
|
status:
200
representations
| text/mathml |
Object Response:
This is MathML file representing the requested object.
|
|
status:
200
representations
| application/excel |
Object Response:
This is Microsoft Excel file representing the requested object.
|
|
status:
200
representations
| application/ppt |
Object Response:
This is Microsoft Powerpoint file representing the requested object.
|
|
status:
200
representations
| application/word |
Object Response:
This is Microsoft Word file representing the requested object.
|
|
status:
200
representations
| text/plain |
Object Response:
This is Plain text file representing the requested object.
|
|
status:
200
representations
| application/rtf |
Object Response:
This is Rich Text Format file representing the requested object.
|
|
status:
200
representations
| video/avi |
Object Response:
This is AVI movie representing the requested object.
|
|
status:
200
representations
| video/x-flv |
Object Response:
This is Flash Video file representing the requested object.
|
|
status:
200
representations
| audio/mp3 |
Object Response:
This is MP3 audio file representing the requested object.
|
|
status:
200
representations
| video/mpeg |
Object Response:
This is MPEG movie representing the requested object.
|
|
status:
200
representations
| video/mpeg4 |
Object Response:
This is MPEG-4 movie representing the requested object.
|
|
status:
200
representations
| video/quicktime |
Object Response:
This is Quicktime movie representing the requested object.
|
|
status:
200
representations
| application/x-tar |
Object Response:
This is TAR file representing the requested object.
|
|
status:
200
representations
| application/zip |
Object Response:
This is ZIP file representing the requested object.
|
|
status:
200
representations
| application/vnd.google-earth.kml+xml |
Object Response:
This is Google Earth KML+XML file representing the requested object.
|
|
status:
200
representations
| application/vnd.google-earth.kmz |
Object Response:
This is Google Earth ZIP file representing the requested object.
|
|
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
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 |
Object Retrieval API:
This represents retrieval of a thumbnail image associated with the document reference (PII).
Methods
request
header params
| Accept |
xsd:string
(required)
default: */*
options:
image/gif |
This represents the acceptable mime types for which the response can be generated.
|
| 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".
|
| 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 |
Represents the version of the resource that should be received.
|
query params
| httpAccept |
xsd:string
options:
image/gif |
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.
|
responses
status:
200
representations
| image/gif |
Object Response:
This is GIF image file representing the requested object.
|
|
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
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 |
Object Retrieval API:
This represents retrieval of a thumbnail image associated with the document reference (DOI).
Methods
request
header params
| Accept |
xsd:string
(required)
default: */*
options:
image/gif |
This represents the acceptable mime types for which the response can be generated.
|
| 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".
|
| 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 |
Represents the version of the resource that should be received.
|
query params
| httpAccept |
xsd:string
options:
image/gif |
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.
|
| 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.
|
responses
status:
200
representations
| image/gif |
Object Response:
This is GIF image file representing the requested object.
|
|
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
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 |
Object Retrieval API:
This represents retrieval of a thumbnail image associated with the document reference (Scopus ID).
Methods
request
header params
| Accept |
xsd:string
(required)
default: */*
options:
image/gif |
This represents the acceptable mime types for which the response can be generated.
|
| 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".
|
| 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 |
Represents the version of the resource that should be received.
|
query params
| httpAccept |
xsd:string
options:
image/gif |
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.
|
responses
status:
200
representations
| image/gif |
Object Response:
This is GIF image file representing the requested object.
|
|
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
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 |
Object Retrieval API:
This represents retrieval of a thumbnail image associated with the document reference (Pubmed ID).
Methods
request
header params
| Accept |
xsd:string
(required)
default: */*
options:
image/gif |
This represents the acceptable mime types for which the response can be generated.
|
| 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".
|
| 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 |
Represents the version of the resource that should be received.
|
query params
| httpAccept |
xsd:string
options:
image/gif |
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.
|
responses
status:
200
representations
| image/gif |
Object Response:
This is GIF image file representing the requested object.
|
|
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
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 |
Object Retrieval API:
This represents retrieval of a regular-sized image associated with the document reference (PII).
Methods
request
header params
| Accept |
xsd:string
(required)
default: */*
options:
image/gif, image/jpeg |
This represents the acceptable mime types for which the response can be generated.
|
| 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".
|
| 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 |
Represents the version of the resource that should be received.
|
query params
| httpAccept |
xsd:string
options:
image/gif, image/jpeg |
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.
|
responses
status:
200
representations
| image/gif |
Object Response:
This is GIF image file representing the requested object.
|
|
status:
200
representations
| image/jpeg |
Object Response:
This is JPEG image file representing the requested object.
|
|
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
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 |
Object Retrieval API:
This represents retrieval of a regular-sized image associated with the document reference (DOI).
Methods
request
header params
| Accept |
xsd:string
(required)
default: */*
options:
image/gif, image/jpeg |
This represents the acceptable mime types for which the response can be generated.
|
| 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".
|
| 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 |
Represents the version of the resource that should be received.
|
query params
| httpAccept |
xsd:string
options:
image/gif, image/jpeg |
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.
|
responses
status:
200
representations
| image/gif |
Object Response:
This is GIF image file representing the requested object.
|
|
status:
200
representations
| image/jpeg |
Object Response:
This is JPEG image file representing the requested object.
|
|
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
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 |
Object Retrieval API:
This represents retrieval of a regular-sized image associated with the document reference (Scopus ID).
Methods
request
header params
| Accept |
xsd:string
(required)
default: */*
options:
image/gif, image/jpeg |
This represents the acceptable mime types for which the response can be generated.
|
| 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".
|
| 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 |
Represents the version of the resource that should be received.
|
query params
| httpAccept |
xsd:string
options:
image/gif, image/jpeg |
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.
|
responses
status:
200
representations
| image/gif |
Object Response:
This is GIF image file representing the requested object.
|
|
status:
200
representations
| image/jpeg |
Object Response:
This is JPEG image file representing the requested object.
|
|
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
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 |
Object Retrieval API:
This represents retrieval of a regular-sized image associated with the document reference (Pubmed ID).
Methods
request
header params
| Accept |
xsd:string
(required)
default: */*
options:
image/gif, image/jpeg |
This represents the acceptable mime types for which the response can be generated.
|
| 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".
|
| 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 |
Represents the version of the resource that should be received.
|
query params
| httpAccept |
xsd:string
options:
image/gif, image/jpeg |
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.
|
responses
status:
200
representations
| image/gif |
Object Response:
This is GIF image file representing the requested object.
|
|
status:
200
representations
| image/jpeg |
Object Response:
This is JPEG image file representing the requested object.
|
|
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
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 |
Object Retrieval API:
This represents retrieval of a high-resolution image associated with the document reference (PII).
Methods
request
header params
| Accept |
xsd:string
(required)
default: */*
options:
image/gif, image/jpeg |
This represents the acceptable mime types for which the response can be generated.
|
| 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".
|
| 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 |
Represents the version of the resource that should be received.
|
query params
| httpAccept |
xsd:string
options:
image/gif, image/jpeg |
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.
|
responses
status:
200
representations
| image/gif |
Object Response:
This is GIF image file representing the requested object.
|
|
status:
200
representations
| image/jpeg |
Object Response:
This is JPEG image file representing the requested object.
|
|
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
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 |
Object Retrieval API:
This represents retrieval of a high-resolution image associated with the document reference (DOI).
Methods
request
header params
| Accept |
xsd:string
(required)
default: */*
options:
image/gif, image/jpeg |
This represents the acceptable mime types for which the response can be generated.
|
| 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".
|
| 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 |
Represents the version of the resource that should be received.
|
query params
| httpAccept |
xsd:string
options:
image/gif, image/jpeg |
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.
|
responses
status:
200
representations
| image/gif |
Object Response:
This is GIF image file representing the requested object.
|
|
status:
200
representations
| image/jpeg |
Object Response:
This is JPEG image file representing the requested object.
|
|
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
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 |
Object Retrieval API:
This represents retrieval of a high-resolution image associated with the document reference (Scopus ID).
Methods
request
header params
| Accept |
xsd:string
(required)
default: */*
options:
image/gif, image/jpeg |
This represents the acceptable mime types for which the response can be generated.
|
| 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".
|
| 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 |
Represents the version of the resource that should be received.
|
query params
| httpAccept |
xsd:string
options:
image/gif, image/jpeg |
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.
|
responses
status:
200
representations
| image/gif |
Object Response:
This is GIF image file representing the requested object.
|
|
status:
200
representations
| image/jpeg |
Object Response:
This is JPEG image file representing the requested object.
|
|
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
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 |
Object Retrieval API:
This represents retrieval of a high-resolution image associated with the document reference (Pubmed ID).
Methods
request
header params
| Accept |
xsd:string
(required)
default: */*
options:
image/gif, image/jpeg |
This represents the acceptable mime types for which the response can be generated.
|
| 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".
|
| 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 |
Represents the version of the resource that should be received.
|
query params
| httpAccept |
xsd:string
options:
image/gif, image/jpeg |
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.
|
responses
status:
200
representations
| image/gif |
Object Response:
This is GIF image file representing the requested object.
|
|
status:
200
representations
| image/jpeg |
Object Response:
This is JPEG image file representing the requested object.
|
|
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
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 |
