The Engineering Village Retrieval API

This represents the available REST interfaces associated with Engineering Village record retrieval.

Interactive Swagger documentation can be found here along with the Swagger definition

Summary

Resource Method Description
https://api.elsevier.com/content/ev/records GET

Engineering Village Retreival API: This represents a record retrieval from the Engineering Village databases.

Resources


https://api.elsevier.com/content/ev/records

Methods
GET fetchRecord()

Engineering Village Retreival API: This represents a record retrieval from the Engineering Village databases.

request
header params
Accept xs:string
default: application/json
options: application/json, application/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 xs: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-AuthToken xs: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"
els-client-ip xs:string This represents a end-user ip.
X-ELS-APIKey xs: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-Insttoken xs: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 xs: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 xs:string
options: 1.0
Resource version (for future use). Default value="1.0"

query params
apiKey xs:string
(required)
Required if no X-ELS-APIKey HTTP header, this represents a unique application developer key providing access to resource.
docId xs:string
(required)
(repeating)
DocId values corresponding to record to retreieve. The docId values are found in the DOC/DOC-ID values of the results returned by the Engineering Village Search API.
ver xs:string
options: 1.0
Override for HTTP header X-ELS-ResourceVersion
httpaccept xs:string
options: application/json, application/xml
Override for HTTP header Accept, this represents the acceptable mime types in which the response can be generated.
access_token xs: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 xs: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.
reqId xs: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.

responses
status:
200 - Engineering Village Retreival Response
representations
application/xml Sample XML Output
application/json Sample JSON Output
status:
400 - Invalid Request - This is an error that occurs when invalid information is submitted.
representations
application/json
text/xml Invalid Request Sample
status:
401 - Authentication Error - This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (authtoken or APIKey).
representations
application/json
text/xml Authentication Error Sample
status:
403 - Authorization/Entitlements Error - This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated.
representations
application/json
text/xml Authorization Error Sample
status:
429 - Quota Exceeded - This is an error that occurs when a requester has exceeded the quota limits associated with their API Key.
representations
application/json
text/xml Quota Exceeded Sample
status:
500 - Generic Error - This is a general purpose error condition, typically due to back-end processing errors.
representations
application/json
text/xml