search

The search operation submits a search query to the specified database edition and retrieves data. This operation returns a query ID that can be used in subsequent operations to retrieve more records.

WSDL Declarations

The input message is defined by the woksearch:search type.

The output message is defined by the woksearch:searchResponse 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

queryParameters

complex

databaseId

string

Database to search. Must be a valid database ID.

userQuery

string

User query for requesting data. The query parser will return errors for invalid queries

editions

complex

List of editions to be searched. If null, user permissions will be substituted.

symbolicTimeSpan

string

This element defines a range of load dates. The load date is the date when a record was added to a database. If symbolicTimeSpan is specified, the timeSpan parameter must be omitted. If timeSpan and symbolicTimeSpan are both omitted, then the maximum publication date time span will be inferred from the editions data.

timeSpan

complex

This element defines specifies a range of publication dates. If timeSpan is used, the symbolicTimeSpan parameter must be omitted. If timeSpan and symbolicTimeSpan are both omitted, then the maximum time span will be inferred from the editions data.

queryLanguage

string

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

editions

Name

Type

Description

collection

string

Name of the collection

edition

string

Name of the edition

symbolicTimeSpan

Valid Values

Description

1week

Specifies to use the end date as today and the begin date as 1 week prior to today.

2week

Specifies to use the end date as today and the begin date as 2 weeks prior to today.

4week

Specifies to use the end date as today and the begin date as 4 weeks prior to today.

timeSpan

Name

Type

Description

begin

string

Beginning date for this search. Format is: YYYY-MM-DD

end

string

Ending date for this search. Format is: YYYY-MM-DD

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.

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
   xmlns:woksearch="http://woksearch.v3.wokmws.thomsonreuters.com">
   <soapenv:Header/>
   <soapenv:Body>
      <woksearch:search>
         <queryParameters>
            <databaseId>WOS</databaseId>   
            <userQuery>TS=(cadmium OR lead)</userQuery>
            <editions>
               <collection>WOS</collection>
               <edition>SCI</edition>
            </editions>           
            <timeSpan>
               <begin>2000-01-01</begin>
               <end>2011-12-31</end>
            </timeSpan>        
            <queryLanguage>en</queryLanguage>
         </queryParameters>
         <retrieveParameters>
            <firstRecord>1</firstRecord>
            <count>5</count>
            <option>
               <key>RecordIDs</key>
               <value>On</value>
            </option>
            <option>            
               <key>targetNamespace</key>
               <value>http://scientific.thomsonreuters.com/schema/wok5.4/public/FullRecord</value>
            </option>            
        </retrieveParameters>
      </woksearch:search>
   </soapenv:Body>
</soapenv:Envelope>