Skip to main content

Elsevier Developer Portal

Affiliation Retrieval API

This represents the interface to retrieve a SCOPUS Affiliation Profile. The response can contain links to Scopus Search and Author Profiles. The affiliation profiles are indexed and can be searched using Affiliation Search API.



Schemas for the 'institution-profile' element of the full affiliation profile can be found at https://schema.elsevier.com/dtds/document/profile/.



The following chart shows the Affiliation Retrieval Views.

Summary

Resource Method Description
https://api.elsevier.com/content/affiliation/affiliation_id/{affiliation_id} GET
 Affiliation Retrieval API: This represents retrieval of a SCOPUS Affiliation Profile by unique Affiliation ID.
https://api.elsevier.com/content/affiliation/eid/{eid} GET
 Affiliation Retrieval API: This represents retrieval of a SCOPUS Affiliation Profile by EID (Electronic Identifier).

Resources


https://api.elsevier.com/content/affiliation/affiliation_id/{affiliation_id}

Affiliation Retrieval API: This represents retrieval of a SCOPUS Affiliation Profile by unique Affiliation ID.

Methods
GET simple()

request
header params
Accept xsd:string
(required)
default: text/xml
options: text/xml, application/xml, application/json, application/rdf+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 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 Represents the version of the resource that should be received.

query params
httpAccept xsd:string
options: text/xml, application/xml, application/json, application/rdf+xml		 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 Override for HTTP header X-ELS-ResourceVersion, this represents the version of the resource that should be received.
view xsd:string
default: LIGHT
options: LIGHT, STANDARD, DOCUMENTS, AUTHORS, ENTITLED

This alias represents the list of elements that will be returned in the response.



The following chart shows the Affiliation Retrieval 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.

Note that this is cannot be used in conjunction with responses associated with the specific views DOCUMENTS and AUTHORS.



ex. field=url,identifier,description
startref xsd:string

Numeric value representing the results offset (i.e. starting position for the search results). The maximum for this value is a system-level default (varies with search cluster) minus the number of results requested. If not specified the offset will be set to zero (i.e. first search result)



ex. startref=5
refcount xsd:string

Numeric value representing the maximum number of results to be returned for the search. If not provided this will be set to a system default based on service level.

In addition the number cannot exceed the maximum system default - if it does an error will be returned.



ex. refcount=10

responses
status:
200
representations
text/xml Affiliation XML Response: This is XML representing the requested document. XML Sample
status:
200
representations
application/xml Affiliation XML Response: This is XML representing the requested document. XML Sample
status:
200
representations
application/json Affiliation JSON Response: This is JSON representing the requested document. JSON Sample
status:
200
representations
application/rdf+xml Affiliation RDF Response: This is RDF representing the requested document. RDF 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/affiliation/eid/{eid}

Affiliation Retrieval API: This represents retrieval of a SCOPUS Affiliation Profile by EID (Electronic Identifier).

Methods
GET simple()

request
header params
Accept xsd:string
(required)
default: text/xml
options: text/xml, application/xml, application/json, application/rdf+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 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 Represents the version of the resource that should be received.

query params
httpAccept xsd:string
options: text/xml, application/xml, application/json, application/rdf+xml		 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 Override for HTTP header X-ELS-ResourceVersion, this represents the version of the resource that should be received.
view xsd:string
default: LIGHT
options: LIGHT, STANDARD, DOCUMENTS, AUTHORS, ENTITLED

This alias represents the list of elements that will be returned in the response.



The following chart shows the Affiliation Retrieval 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.

Note that this is cannot be used in conjunction with responses associated with the specific views DOCUMENTS and AUTHORS.



ex. field=url,identifier,description
startref xsd:string

Numeric value representing the results offset (i.e. starting position for the search results). The maximum for this value is a system-level default (varies with search cluster) minus the number of results requested. If not specified the offset will be set to zero (i.e. first search result)



ex. startref=5
refcount xsd:string

Numeric value representing the maximum number of results to be returned for the search. If not provided this will be set to a system default based on service level.

In addition the number cannot exceed the maximum system default - if it does an error will be returned.



ex. refcount=10

responses
status:
200
representations
text/xml Affiliation XML Response: This is XML representing the requested document. XML Sample
status:
200
representations
application/xml Affiliation XML Response: This is XML representing the requested document. XML Sample
status:
200
representations
application/json Affiliation JSON Response: This is JSON representing the requested document. JSON Sample
status:
200
representations
application/rdf+xml Affiliation RDF Response: This is RDF representing the requested document. RDF 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