Request Message Parameters

The following operations request data from a dataset: 

  • getIncitesDatasetByDatasetCode
  • getIncitesDatasetByDeptName
  • getIncitesDatasetByEmployeeID
  • getIncitesDatasetByUT

Every request must include the following elements:

Element

Type

Description

datasetCode

string

Unique dataset ID

recordCount

integer

Number of records to be returned. The maximum is 100 per request.

startRecord

integer

First record to be returned. For example, if you request that 100 records be returned, you can limit retrieval to records 51-100 by specifying 51 as the startRecord.

format

string

Output format. The content of this element may take one of two values: TR or CERIF.

fieldsList

fieldsList is a complex type with one subelement, fieldName. It enables you to request up to four optional fields. fieldsList is optional. If the element is empty or commented out, then Web of Science records with default fields are returned.

Element

Type

Description

fieldName

string

Optional Web of Science record field

fieldName may take any of the following values:

String Value

Description

subjectAreas

Web of Science subject areas to which the journal has been assigned.

institutionAuthors

Authors from the institution that supplied the dataset.

wosAuthors

Authors as they appear in Web of Science records. The count attribute is the number of authors. The pos attribute is the position of the author in an author list.

citationsPerYear

Number of citations received by the document in each year. The years specified are database years, not publication years. The sum of the citations per year should equal the Times Cited value for the document.

For example, in the following getIncitesDatasetByUT request, all four optional fields are requested:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:bean="http://beans.incitesws.thomsonreuters.com">
   <soapenv:Header/>
   <soapenv:Body>
      <bean:getIncitesDatasetByUT>
         <datasetCode>0097AP01</datasetCode>
         <bean:utList>
            <ut>A1991MG66700006</ut>
            <ut>A1991MG66700007</ut>
            <ut>A1991MG66700008</ut>
            <ut>A1991MG66700009</ut>
            <ut>A1991MG667000010</ut>
            <ut>A1991MG667000011</ut>
            <ut>A1991MG667000012</ut>
         </bean:utList>
         <format>TR</format>
         <!--Optional:-->
         <bean:fieldsList>
            <!--Zero or more repetitions:-->
            <fieldName>institutionAuthors</fieldName>
            <fieldName>citationsPerYear</fieldName>
            <fieldName>wosAuthors</fieldName>
            <fieldName>subjectAreas</fieldName>
         </bean:fieldsList>
      </bean:getIncitesDatasetByUT>
   </soapenv:Body>
</soapenv:Envelope>

fieldsList is an optional element.

trs_topicTypereference
productInCites / ICWS
productInCites / ICWS
Comments (0)