retrieveById

The retrieveById operation returns records identified by unique identifiers. The identifiers are specific to each database.

WSDL Declarations

The input message is defined by the woksearchlite:retrieveByID type.

The output message is defined by the woksearchlite:retrieveByIDResponse type.

Prerequisites

The client must be entitled to each edition and time span to be searched. A valid session, identified by sessionID, must be active before the operation can be performed.

Query Parameters

Query parameters specify the target database and define retrieval criteria.

Name

Type

Description

databaseId

string

Database to search. Must be a valid database ID.

uid

string

A unique item identifier. It cannot be null or contain an empty string.

queryLanguage

string

This element can take only one value: en for English.

uid

The uid is a unique item identifier. It is enclosed by the UID element in database records. You can obtain a list of  unique identifiers for the records returned by a search operation by using the database option RecordIDs. See the sample request for the search operation.

Database

uid source

Description

Example from Database Record

WOS

UID element

Unique record identifier

WOS:000072501400019

Results Metadata

Name

Type

Description

queryId

string

The identifier of the query object. The query object is stored in the session. The session ID and queryId can be used to retrieve additional records.

recordsFound

int

The number of records found that satisfy this query.

recordsSearched

long

The number of records searched.

parent

string

optionValue

array of labelValuesPair

Metadata about the records returned. These metadata must be specified in the request using the retrieve parameter option.

records

complex

List of records returned by the operation.

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
   xmlns:woksearch="http://woksearchlite.v3.wokmws.thomsonreuters.com">
   <soapenv:Header/>
   <soapenv:Body>
      <woksearch:retrieveById>
         <databaseId>WOS</databaseId> 
         
         <uid>WOS:000270372400005</uid>
         <uid>WOS:000075022300003</uid>
               
         <queryLanguage>en</queryLanguage>
         
         <retrieveParameters>
            <firstRecord>1</firstRecord>
            <count>2</count>
            <sortField>
               <name>AU</name>
               <sort>A</sort>
            </sortField>  
         </retrieveParameters>
      </woksearch:retrieveById>
   </soapenv:Body>
</soapenv:Envelope>