Resource Versions

Versioning for ELSAPI, as a general concept, does not exist. Most of the back-end data is maintained at only the latest version, so artifacts like full text documents and abstracts can only be retrieved in a specific version format.

 

However, for those response items generated specifically by ELSAPI (ex. search results, API-enhanced metadata) versioning is handled through use of the resource version parameter. This can be passed in the request through one of two different ways:

 

·         HTTP Header ‘X-ELS-ResourceVersion’

·         Query String Parameter ‘ver’

 

By default, if no resource version is specified, the version defaults to whatever is “current”. Although there may be specific switches per resource (which can be sent as a list, delimited by space or comma), the following values should always be applicable:

 

Resource Version

Meaning

prev

Returns the “previous” response version. This is to aid in clients that cannot make an immediate switch for a particular response payload change and does not wish to receive the “new” version. Additional switches, if available, can be used in conjunction with this specification to receive only those new for desired format changes.

new

Overrides all other switches and returns the latest response.

 

The following outlines the list of format differences for ‘prev’ and ‘new’ versions supported for each ELSAPI resource.

SCOPUS Search API

 

Facet

 

(also controlled via ‘facetexpand’)

Default/”new” Response

“prev” Response

doctype

        <category>
            <label>Article</label>
            <value>ar</value>
            <name>ar</name>
            <hitCount>251762</hitCount>
        </category>

        <category>

            <name>ar</name>
            <hitCount>251762</hitCount>
        </category>

subjarea

        <category>
            <label>Medicine (all)</label>
            <id>2700</id>
            <value>MEDI</value>
            <name>MEDI</name>
            <hitCount>229506</hitCount>
        </category>

        <category>

            <name>MEDI</name>
            <hitCount>229506</hitCount>
        </category>

af-id

        <category>
            <label/>
            <id>affiliation_id:60014232</id>
            <value>60014232</value>
            <name>(id=60014232)</name>
            <hitCount>5526</hitCount>
        </category>

 

        <category>

            <name>(id=60014232)</name>
            <hitCount>5526</hitCount>
        </category>

 

srctype

        <category>
            <label>Journal</label>
            <value>j</value>
            <name>j</name>
            <hitCount>323232</hitCount>
        </category>

 

        <category>

            <name>j</name>
            <hitCount>323232</hitCount>
        </category>

 

 

AUTHOR Search API

 

Response Field

Default/“new” Response

“prev” Response

subject-area

 

(also controlled via ‘subjexpand’ or ‘allexpand’)

        <subject abbr="ENGI" frequency="2235">Engineering (all)</subject>
        <subject abbr="COMP" frequency="1250">Computer Science (all)</subject>
        <subject abbr="MEDI" frequency="1100">Medicine (all)</subject>

 

<subject>2235 ENGI | 1250 COMP | 1100 MEDI</subject>

 

Facet

 

(also controlled via ‘facetexpand’ or ‘allexpand’)

Default/“new” Response

“prev” Response

auth-subclus

        <category>
            <label>Medicine (all)</label>
            <id>2700</id>
            <value>MEDI</value>
            <name>MEDI</name>
            <hitCount>1236408</hitCount>
        </category>

 

        <category>

            <name>MEDI</name>
            <hitCount>1236408</hitCount>
        </category>

 

af-id

        <category>
            <label/>
            <id>affiliation_id:60014232</id>
            <value>60014232</value>
            <name>(id=60014232)</name>
            <hitCount>5526</hitCount>
        </category>

 

        <category>

            <name>(id=60014232)</name>
            <hitCount>5526</hitCount>
        </category>

 

 

Science Direct Search API

 

Facet

Default/“new” Response

“prev” Response

srctitle

        <category>
            <label>The Lancet</label>
            <id>issn:01406736</id>
            <type>journal</type>
            <value>271074</value>
            <name>(issn=01406736)The Lancet</name>
            <hitCount>67745</hitCount>
        </category>

        <category>
            <name>(issn=01406736)The Lancet</name>
            <hitCount>67745</hitCount>
        </category>

contenttype

    <category>
        <label>Journal</label>
        <value>1</value>
        <name>1</name>
        <hitCount>1264930</hitCount>
    </category>

    <category>

        <name>1</name>
        <hitCount>1264930</hitCount>
    </category>

 

Science Direct Object Search API

 

 

Facet

Default/“new” Response

“prev” Response

srctitle

        <category>
            <label>The Lancet</label>
            <id>issn:01406736</id>
            <type>journal</type>
            <value>271074</value>
            <name>(issn=01406736)The Lancet</name>
            <hitCount>67745</hitCount>
        </category>

        <category>
            <name>(issn=01406736)The Lancet</name>
            <hitCount>67745</hitCount>
        </category>

contenttype

    <category>
        <label>Journal</label>
        <value>1</value>
        <name>1</name>
        <hitCount>1264930</hitCount>
    </category>

    <category>

        <name>1</name>
        <hitCount>1264930</hitCount>
    </category>

 

Article Retrieval API

 

Multiple authors listed as dc:creator instead of ‘authors’ element

Response Field

Default/“new” Response

“prev” Response

dc:creator

authors

 

<dc:creator>Ramadhani, Nisrina</dc:creator>
<dc:creator>Shabir, Mehwish</dc:creator>
<dc:creator>McConville, Christopher</dc:creator>

 

<dc:creator>Ramadhani, Nisrina</dc:creator>

 <authors>Nisrina, Ramadhani | Mehwish, Shabir | Christopher, McConville</authors>

 

 

Nonserial Title Metadata API

 

Response Field

Default/“new” Response

“prev” Response

subject-area

 

<subject-area code="209" abbrev="surgery"> Surgery</subject-area>

 

<subject-area>209</subject-area>

 

 

All Other APIs

 

No special version specifications available.