Article Hosting Permission API

This represents open access information for a particular full text article.

Summary

Resource	Method	Description
https://api.elsevier.com/content/article/hostingpermission/pii/{pii}	GET	Article Hosting Permission API: This represents retrieval permissions associated with a full text article by PII (Publication Item Identifier).

https://api.elsevier.com/content/article/hostingpermission/eid/{eid}	GET	Article Hosting Permission API: This represents retrieval permissions associated with a full text article by EID (Electronic Identifier).

https://api.elsevier.com/content/article/hostingpermission/doi/{doi}	GET	Article Hosting Permission API: This represents retrieval permissions associated with a full text article by DOI (Document Object Identifier).

Resources

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

Article Hosting Permission API: This represents retrieval permissions associated with a full text article by PII (Publication Item Identifier).

Methods

GET

simple()

request

header params

Accept	xsd:string (required) default: `text/xml` options: `text/xml`, `application/json`	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.
X-ELS-APIKey	xsd:string	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-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.
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.
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

Article Hosting Permission XML Response: This is XML representing the requested document.

XML Example

status:

200

representations

application/json

Article Hosting Permission JSON Response: This is JSON representing the requested document.

JSON Example

status:

400

representations

text/xml

Invalid Request: This is an error that occurs when invalid information is submitted.

Invalid Request Example

status:

401

representations

text/xml

Authentication Error: This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (authtoken or APIKey).

Authentication Error Example

status:

403

representations

text/xml

Authorization/Entitlements Error: This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated.

Authorization Error Example

status:

404

representations

text/xml

Resource Not Found Error: This is an error that occurs when the requested resource cannot be found.

Resource Not Found Example

status:

405

representations

text/xml

Invalid HTTP Method: This is an error that occurs when the requested HTTP Method is invalid.

Invalid Method Example

status:

406

representations

text/xml

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

Invalid Mime Type Example

status:

429

representations

text/xml

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

Quota Exceeded Example

status:

500

representations

text/xml

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

Generic Error Example

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

Article Hosting Permission API: This represents retrieval permissions associated with a full text article by EID (Electronic Identifier).

Methods

GET

simple()

request

header params

Accept	xsd:string (required) default: `text/xml` options: `text/xml`, `application/json`	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.
X-ELS-APIKey	xsd:string	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-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.
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.
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

Article Hosting Permission XML Response: This is XML representing the requested document.

XML Example

status:

200

representations

application/json

Article Hosting Permission JSON Response: This is JSON representing the requested document.

JSON Example

status:

400

representations

text/xml

Invalid Request: This is an error that occurs when invalid information is submitted.

Invalid Request Example

status:

401

representations

text/xml

Authentication Error: This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (authtoken or APIKey).

Authentication Error Example

status:

403

representations

text/xml

Authorization/Entitlements Error: This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated.

Authorization Error Example

status:

404

representations

text/xml

Resource Not Found Error: This is an error that occurs when the requested resource cannot be found.

Resource Not Found Example

status:

405

representations

text/xml

Invalid HTTP Method: This is an error that occurs when the requested HTTP Method is invalid.

Invalid Method Example

status:

406

representations

text/xml

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

Invalid Mime Type Example

status:

429

representations

text/xml

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

Quota Exceeded Example

status:

500

representations

text/xml

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

Generic Error Example

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

Article Hosting Permission API: This represents retrieval permissions associated with a full text article by DOI (Document Object Identifier).

Methods

GET

simple()

request

header params

Accept	xsd:string (required) default: `text/xml` options: `text/xml`, `application/json`	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.
X-ELS-APIKey	xsd:string	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-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.
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.
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

Article Hosting Permission XML Response: This is XML representing the requested document.

XML Example

status:

200

representations

application/json

Article Hosting Permission JSON Response: This is JSON representing the requested document.

JSON Example

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