Enhancement Fragment API

This represents search or retrieval of the enhancement fragments associated with a full text article. When utilizing a source or target document identifier, the result is metadata for all associated enhancement fragments. When using an enhancement fragment identifier, the result is the text of enhancement fragment itself. Each fragment will, by definition, link to an associated Full-Text article.

The following chart shows the Enhancement Fragment Views.

Summary

Resource	Method	Description
https://api.elsevier.com/content/fragment/pii/{pii}	GET	Enhancement Fragment API: This represents retrieval of the enhancement fragment metadata associated with a full text article.

https://api.elsevier.com/content/fragment/eid/{eid}	GET	Enhancement Fragment API: Depending upon the type of electronic identifier, this represents retrieval of the enhancement fragment metadata associated with a full text article (when providing the target document EID) or the enhancement fragment text itself (when the enhancement fragment EID is provided).

https://api.elsevier.com/content/fragment/isbn/{isbn}	GET	Enhancement Fragment API: This represents retrieval of the enhancement fragment metadata associated with a content source collection.

Resources

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

Enhancement Fragment API: This represents retrieval of the enhancement fragment metadata associated with a full text article.

Methods

GET

simple()

request

header params

Accept	xsd:string (required) default: `text/xml` options: `text/xml`, `application/json`	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 options: `new`	Represents the version of the resource that should be received. Note that submitting new always returns the latest response version.

query params

httpAccept	xsd:string options: `text/xml`, `application/json`	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 options: `new`	Override for HTTP header X-ELS-ResourceVersion, this represents the version of the resource that should be received.
view	xsd:string default: `FULL` options: `FULL`	This alias represents the list of elements that will be returned in the response. The following chart shows the Enhancement Fragment Views.
field	xsd:string	This alias represents the name of specific fields that should be returned. The list of fields include all of the fields returned in the response payload (see view). Multiple fields can be specified, delimited by commas. ex. field=url,identifier,description

responses

status:

200

representations

text/xml

Full Text XML Response: This is XML representing the requested document.

XML Sample

status:

200

representations

application/json

Full Text JSON Response: This is JSON representing the requested document.

JSON 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

representations

text/xml

Invalid Mime Type: This is an error that occurs when the requested mime type is invalid.

Invalid Mime Type Example

status:

429

representations

text/xml

Quota Exceeded: This is an error that occurs when a requester has exceeded the quota limits associated with their API Key.

Quota Exceeded Example

status:

500

representations

text/xml

Generic Error: This is a general purpose error condition, typically due to back-end processing errors.

Generic Error Example

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

Enhancement Fragment API: Depending upon the type of electronic identifier, this represents retrieval of the enhancement fragment metadata associated with a full text article (when providing the target document EID) or the enhancement fragment text itself (when the enhancement fragment EID is provided).

Methods

GET

simple()

request

header params

Accept	xsd:string (required) default: `text/xml` options: `text/xml`, `application/json`	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 options: `new`	Represents the version of the resource that should be received. Note that submitting new always returns the latest response version.

query params

httpAccept	xsd:string options: `text/xml`, `application/json`	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 options: `new`	Override for HTTP header X-ELS-ResourceVersion, this represents the version of the resource that should be received.
view	xsd:string default: `FULL` options: `FULL`	This alias represents the list of elements that will be returned in the response. The following chart shows the Enhancement Fragment Views.
field	xsd:string	This alias represents the name of specific fields that should be returned. The list of fields include all of the fields returned in the response payload (see view). Multiple fields can be specified, delimited by commas. ex. field=url,identifier,description

responses

status:

200

representations

text/xml

Full Text XML Response: This is XML representing the requested document.

XML Sample

status:

200

representations

application/json

Full Text JSON Response: This is JSON representing the requested document.

JSON 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

representations

text/xml

Invalid Mime Type: This is an error that occurs when the requested mime type is invalid.

Invalid Mime Type Example

status:

429

representations

text/xml

Quota Exceeded: This is an error that occurs when a requester has exceeded the quota limits associated with their API Key.

Quota Exceeded Example

status:

500

representations

text/xml

Generic Error: This is a general purpose error condition, typically due to back-end processing errors.

Generic Error Example

https://api.elsevier.com/content/fragment/isbn/{isbn}

Enhancement Fragment API: This represents retrieval of the enhancement fragment metadata associated with a content source collection.

Methods

GET

simple()

request

header params

Accept	xsd:string (required) default: `text/xml` options: `text/xml`, `application/json`	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 options: `new`	Represents the version of the resource that should be received. Note that submitting new always returns the latest response version.

query params

httpAccept	xsd:string options: `text/xml`, `application/json`	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 options: `new`	Override for HTTP header X-ELS-ResourceVersion, this represents the version of the resource that should be received.
view	xsd:string default: `FULL` options: `FULL`	This alias represents the list of elements that will be returned in the response. The following chart shows the Enhancement Fragment Views.
field	xsd:string	This alias represents the name of specific fields that should be returned. The list of fields include all of the fields returned in the response payload (see view). Multiple fields can be specified, delimited by commas. ex. field=url,identifier,description