Resource | Method | Description |
---|---|---|
https://api.elsevier.com/content/search/author | GET |
Author Search API:
|
Author Search API:
GET | simple() |
Accept | xsd:string (required) default: application/json options: application/json, application/atom+xml, application/xml |
|
Authorization | xsd:string |
|
X-ELS-APIKey | xsd:string (required) |
|
X-ELS-Authtoken | xsd:string |
|
X-ELS-Insttoken | xsd:string |
|
X-ELS-ReqId | xsd:string |
|
X-ELS-ResourceVersion | xsd:string options: facetexpand, subjexpand, allexpand, new |
Represents the version of the resource that should be received. Multiple attributes can be submitted by separating with commas or semicolons. Options include: subjexpand - adds detail to the subject-area field by detailing each entry as a subject facetexpand - adds new fields under each facet returned (where applicable) allexpand - executes both facetexpand and subjexpand new - Returns the most recent and prototyped features |
httpAccept | xsd:string options: application/json, application/atom+xml, application/xml |
|
access_token | xsd:string |
|
insttoken | xsd:string |
|
apiKey | xsd:string |
|
reqId | xsd:string |
|
ver | xsd:string options: facetexpand, subjexpand, allexpand, new |
Override for HTTP header X-ELS-ResourceVersion, this represents the version of the resource that should be received. Multiple attributes can be submitted by separating with commas or semicolons. Options include: subjexpand - adds detail to the subject-area field by detailing each entry as a subject facetexpand - adds new fields under each facet returned (where applicable) allexpand - executes both facetexpand and subjexpand new - Returns the most recent and prototyped features |
query | xsd:string |
This represents the boolean search to be executed against the Author cluster. There is additional information regarding Search Tips. ex. query=affil(university) |
co-author | xsd:number |
This is an alternative to the query parameter where an author identifier can be submitted and a list of all associated co-authors will be returned. If this parameter is present the query parameter is ignored. Note that only a single author identifier should be submitted. |
view | xsd:string default: STANDARD options: STANDARD |
This alias represents the list of elements that will be returned in the response. The following chart shows the Author Search 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 specifying this parameter overrides the view parameter. ex. field=url,identifier,description |
suppressNavLinks | xsd:string default: false options: true, false |
This parameter is used to suppress the inclusion of top-level navigation links in the response payload. |
start | 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. start=5 |
count | 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. count=10 |
sort | xsd:string options: affiliation-city, affiliation-country, affiliation-name, affilsortname, document-count, eid, given-name, initials, preffirstsort, surname |
Represents the sort field name and order. A plus in front of the sort field name indicates ascending order, a minus indicates descending order. If sort order is not specified (i.e. no + or -) then the order defaults to ascending (ASC). Up to three fields can be specified, each delimited by a comma. The precedence is determined by their order (i.e. first is primary, second is secondary, and third is tertiary). +/-{field name}[,+/-{field name} ex. sort=+datesort,-priorordersort |
facets | xsd:string options: srctitle, af-id, affilcity, affilcountry, auth-subclus, active |
Represents the navigator that should be included in the search results. One or more navigators can be specified on the request, delimited by a semicolon Different dimensions of the navigator will be represented within parentheses. These dimensions include: count : the number of "buckets" to include (i.e. how many navigator entries) sort : how the navigators should be sorted. Options include na (Modifier name, ascending), fd (Modifier frequency, descending), and fdna (Modifier frequency descending, secondary sort through unity by name, ascending). prefix : filters the facet values to only those matching the prefix specified (not applicable for numeric values). In addition, qualifiers can be specified to include or exclude values from the response (i.e. filter). The options: include : include only the value specified from the facet response. include_above : include only values above the value specified from the facet response. include_below : include only values below the value specified from the facet response. exclude : exclude only the value specified from the facet response. exclude_above : exclude all values above the value specified from the facet response. exclude_below : exclude all values below the value specified from the facet response. ex. facets=affilcity(count=20,sort=na,prefix=Ma);srctitle (prefix=J);auth-subclus(sort=fd);active;af-id(sort=fdna) Available facets include: SRCTITLE - source title AF-ID - affiliation identifier AFFILCITY - affiliation city AFFILCOUNTRY - affiliation country AUTH-SUBCLUS - subject area ACTIVE - active |
alias | xsd:string |
The default behavior is to substitute any author identifiers submitted in the search with their aliased (superseded) counterparts. Thus, a logical search for author id 1234 may be automatically substituted with a logical search for author ids 5678 and 9012 because those are the "superseding" identifiers the original has been mapped to. If 'alias=false' is submitted this behavior will be overridden and the original identifier(s) will NOT be substituted. ex. alias=false |
application/json | Author JSON Response:
|
JSON Example |
application/atom+xml | Author ATOM Response:
|
ATOM+XML Example |
application/xml | Author XML Response:
|
XML Example |
text/xml | Invalid Request:
|
Invalid Request Example |
text/xml | Authentication Error:
|
Authentication Error Example |
text/xml | Authorization/Entitlements Error:
|
Authorization Error Example |
text/xml | Invalid HTTP Method:
|
Invalid Method Example |
text/xml | Invalid Mime Type:
|
Invalid Mime Type Example |
text/xml | Quota Exceeded:
|
Quota Exceeded Example |
text/xml | Generic Error:
|
Generic Error Example |