Holdings Report API

This interface represents a usage report generated for ScienceDirect content. Data available in the universally-accepted Knowledge Base and Related Tools (KBART) format provides a single source for detailed content needs. The KBART joint initiative investigates data problems within the OpenURL supply chain, provides a standardized way to exchange and update content, and broadens access to content.



The report can be generated in CSV/EXCEL, XML, or KBART (plain text) formats.

Summary

Resource Method Description
https://api.elsevier.com/holdings/report.url GET
Holdings Report API: This represents a report generated against against ScienceDirect content.

Resources


https://api.elsevier.com/holdings/report.url

Holdings Report API: This represents a report generated against against ScienceDirect content.

Methods
GET simple()

request
header params
Accept xsd:string
(required)
default: text/csv
options: text/csv, text/plain, text/xml, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
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 or XML mark-up.



Mappings of formats to mime type includes:

CSV - text/csv; charset=UTF-8

XML - text/xml; charset=UTF-8

KBART - text/plain; charset=UTF-8

EXCEL - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet; charset=UTF-8
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/csv, text/plain, text/xml, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Override for HTTP header Accept, this represents the acceptable mime types for which the response can be generated.



Mappings of formats to mime type includes:

CSV - text/csv; charset=UTF-8

XML - text/xml; charset=UTF-8

KBART - text/plain; charset=UTF-8

EXCEL - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet; charset=UTF-8
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.
_platform xsd:string
default: SD
options: SD
Indicates for which back-end platform the report should be generated.
_site xsd:string
default: science
options: science
Indicates for which back-end site the report should be generated.
format xsd:string
default: CSV
options: CSV, XML, KBART, EXCEL
Overrides Accept mime type specifying the format of the report returned.



Mappings of formats to mime type includes:

CSV - text/csv; charset=UTF-8

XML - text/xml; charset=UTF-8

KBART - text/plain; charset=UTF-8

EXCEL - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet; charset=UTF-8

responses
status:
200
representations
text/csv Holdings Report CSV Response: This is CSV representing the requested resource. CSV Example
status:
200
representations
text/xml Holdings Report XML Response: This is XML representing the requested resource. XML Example
status:
200
representations
text/plain Holdings Report KBART Response: This is text representing the requested resource. KBART Example
status:
200
representations
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet Holdings Report EXCEL Response: This is EXCEL representing the requested resource. EXCEL 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:
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. Generic Error Example