Skip to main content

Elsevier Developer Portal

PharmaPendium API Documents Module

This represents the interfaces associated with PharmaPendium search and its auxiliary components.

Summary

Resource Method Description
https://api.elsevier.com/pharma/documents/listDataFields GET

 listDataFields: This represents a request to list data field names available in this module.
https://api.elsevier.com/pharma/documents/listFacets GET

 listFacets: This represents a request to list facets available in this module.
https://api.elsevier.com/pharma/documents/listTaxonomies GET

 listTaxonomies: This represents a request to list all taxonomies available in this module.
https://api.elsevier.com/pharma/documents/lookupFuzzy POST

GET

 lookupFuzzy: This represents a request to lookup elements of a taxonomy specific to this module. Allows wildcards.

lookupFuzzy: This represents a request to lookup elements of a taxonomy specific to this module. Allows wildcards.
https://api.elsevier.com/pharma/documents/search GET

POST

 search: This represents a request to search the module data by specified criteria.

search: This represents a request to search the module data by specified criteria.
https://api.elsevier.com/pharma/documents/suggest GET

 suggest: This represents a request to suggest elements of a taxonomy within this module matching prefix.

Resources


https://api.elsevier.com/pharma/documents/listDataFields

Methods
GET listDataFields()

listDataFields: This represents a request to list data field names available in this module.

request
header params
Accept xsd:string
(required)
default: application/json
options: 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.
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.

query params
httpAccept xsd:string
options: application/json		 Override for HTTP header Accept, this represents the acceptable mime types in 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.

responses
status:
200
representations
application/json List data fields JSON Response: Returns a list of all available data fields for this module.
status:
401
representations
application/json Authentication Error: This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (authtoken or APIKey).
status:
403
representations
application/json Authorization/Entitlements Error: This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated.
status:
404
representations
application/json Resource Not Found Error: This is an error that occurs when the requested resource cannot be found.
status:
429
representations
application/json Quota Exceeded: This is an error that occurs when a requester has exceeded the quota limits associated with their API Key.
status:
500
representations
application/json

https://api.elsevier.com/pharma/documents/listFacets

Methods
GET listFacets()

listFacets: This represents a request to list facets available in this module.

request
header params
Accept xsd:string
(required)
default: application/json
options: 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.
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.

query params
httpAccept xsd:string
options: application/json		 Override for HTTP header Accept, this represents the acceptable mime types in 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.

responses
status:
200
representations
application/json List facets JSON Response: Returns a list of all available facets for this module.
status:
401
representations
application/json Authentication Error: This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (authtoken or APIKey).
status:
403
representations
application/json Authorization/Entitlements Error: This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated.
status:
404
representations
application/json Resource Not Found Error: This is an error that occurs when the requested resource cannot be found.
status:
429
representations
application/json Quota Exceeded: This is an error that occurs when a requester has exceeded the quota limits associated with their API Key.
status:
500
representations
application/json

https://api.elsevier.com/pharma/documents/listTaxonomies

Methods
GET listTaxonomies()

listTaxonomies: This represents a request to list all taxonomies available in this module.

request
header params
Accept xsd:string
(required)
default: application/json
options: 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.
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.

query params
httpAccept xsd:string
options: application/json		 Override for HTTP header Accept, this represents the acceptable mime types in 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.

responses
status:
200
representations
application/json List taxonomies JSON Response: Returns a list of all available taxonomies for this module. tns:listTaxonomies_Response
status:
401
representations
application/json Authentication Error: This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (authtoken or APIKey).
status:
403
representations
application/json Authorization/Entitlements Error: This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated.
status:
404
representations
application/json Resource Not Found Error: This is an error that occurs when the requested resource cannot be found.
status:
429
representations
application/json Quota Exceeded: This is an error that occurs when a requester has exceeded the quota limits associated with their API Key.
status:
500
representations
application/json

https://api.elsevier.com/pharma/documents/lookupFuzzy

Methods
POST lookupFuzzy()

lookupFuzzy: This represents a request to lookup elements of a taxonomy specific to this module. Allows wildcards.

request
header params
Accept xsd:string
(required)
default: application/json
options: 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.
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.

representations
application/json tns:FuzzyLookupFilter
responses
status:
200
representations
application/json Lookup JSON Response: Returns matches for the lookup within the taxonomy. tns:TreeCommonLookupEntity
status:
401
representations
application/json Authentication Error: This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (authtoken or APIKey).
status:
403
representations
application/json Authorization/Entitlements Error: This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated.
status:
404
representations
application/json Resource Not Found Error: This is an error that occurs when the requested resource cannot be found.
status:
429
representations
application/json Quota Exceeded: This is an error that occurs when a requester has exceeded the quota limits associated with their API Key.
status:
500
representations
application/json
GET lookupFuzzy()

lookupFuzzy: This represents a request to lookup elements of a taxonomy specific to this module. Allows wildcards.

request
header params
Accept xsd:string
(required)
default: application/json
options: 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.
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.

query params
query xsd:string
(required)
default: 		query
taxonomy tns:Taxonomy
(required)
default: 		taxonomy

responses
status:
200
representations
application/json Lookup JSON Response: Returns matches for the lookup within the taxonomy. tns:TreeCommonLookupEntity
status:
401
representations
application/json Authentication Error: This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (authtoken or APIKey).
status:
403
representations
application/json Authorization/Entitlements Error: This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated.
status:
404
representations
application/json Resource Not Found Error: This is an error that occurs when the requested resource cannot be found.
status:
429
representations
application/json Quota Exceeded: This is an error that occurs when a requester has exceeded the quota limits associated with their API Key.
status:
500
representations
application/json

https://api.elsevier.com/pharma/documents/search

Methods
GET search()

search: This represents a request to search the module data by specified criteria.

request
header params
Accept xsd:string
(required)
default: application/json
options: 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.
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.

query params
httpAccept xsd:string
options: application/json		 Override for HTTP header Accept, this represents the acceptable mime types in 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.
limitation.firstRow xsd:integer
default: 		First row of requested data to be returned.
limitation.count xsd:integer
default: 		Amount of rows of data to be returned.
displayColumns xsd:string
(repeating)
default: 		Comma-separated list of data field names to be present in the response. If empty, all available data fields will be returned.
text xsd:string
default: 		Text of the query, allows wildcards.
includeSynonyms xsd:boolean
default: 		Defines whether the query should be enriched by synonyms.
drugs xsd:string
(repeating)
default: 		Comma-separated list of drug names, strictly from the PharmaPendium Drugs taxonomy.
drugsFuzzy xsd:string
(repeating)
default: 		Comma-separated list of partial or complete drug (brand) names. Allows wildcards. The search will include drug classes, so the search for 'anesth*' will return results with 'Lidocaine; Prilocaine' as this drug belongs to the Anesthetics class.
facets xsd:string
(repeating)
default: 		Comma-separated list of facets to be returned together with data in the response.
years xsd:long
(repeating)
default: 		Comma-separated list of years.
leaf xsd:boolean
default: false		 Defines whether to return only leaf elements of taxonomies when faceting.

responses
status:
200
representations
application/json Search JSON Response: Returns data and requested facets matching specified criteria. JSON response
status:
401
representations
application/json Authentication Error: This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (authtoken or APIKey).
status:
403
representations
application/json Authorization/Entitlements Error: This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated.
status:
404
representations
application/json Resource Not Found Error: This is an error that occurs when the requested resource cannot be found.
status:
429
representations
application/json Quota Exceeded: This is an error that occurs when a requester has exceeded the quota limits associated with their API Key.
status:
500
representations
application/json
POST search()

search: This represents a request to search the module data by specified criteria.

request
header params
Accept xsd:string
(required)
default: application/json
options: 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.
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.

representations
application/json tns:DocumentAPIFilter
responses
status:
200
representations
application/json Search JSON Response: Returns data and requested facets matching specified criteria. JSON response
status:
401
representations
application/json Authentication Error: This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (authtoken or APIKey).
status:
403
representations
application/json Authorization/Entitlements Error: This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated.
status:
404
representations
application/json Resource Not Found Error: This is an error that occurs when the requested resource cannot be found.
status:
429
representations
application/json Quota Exceeded: This is an error that occurs when a requester has exceeded the quota limits associated with their API Key.
status:
500
representations
application/json

https://api.elsevier.com/pharma/documents/suggest

Methods
GET suggest()

suggest: This represents a request to suggest elements of a taxonomy within this module matching prefix.

request
header params
Accept xsd:string
(required)
default: application/json
options: 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.
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.

query params
httpAccept xsd:string
options: application/json, application/xml, text/xml		 Override for HTTP header Accept, this represents the acceptable mime types in 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.
prefix xsd:string
(required)
default: 		prefix
taxonomy tns:Taxonomy
(required)
default: 		taxonomy

responses
status:
200
representations
application/json Suggest JSON Response: Returns a list of elements of the taxonomy matching prefix. All of the provided elements are guaranteed to have associated data in this module.
status:
401
representations
application/json Authentication Error: This is an error that occurs when a user cannot be authenticated due to missing/invalid credentials (authtoken or APIKey).
status:
403
representations
application/json Authorization/Entitlements Error: This is an error that occurs when a user cannot be authenticated or entitlements cannot be validated.
status:
404
representations
application/json Resource Not Found Error: This is an error that occurs when the requested resource cannot be found.
status:
429
representations
application/json Quota Exceeded: This is an error that occurs when a requester has exceeded the quota limits associated with their API Key.
status:
500
representations
application/json