Tim Brody > SOAP-ISIWoK-3.01 > SOAP::ISIWoK

Download:
SOAP-ISIWoK-3.01.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  0
View/Report Bugs
Module Version: 3.01   Source  

NAME ^

SOAP::ISIWoK - interogate the ISI WoS database

SYNOPSIS ^

  use SOAP::ISIWoK;

  $wos = SOAP::ISIWoK->new;
  
  $som = $wos->authenticate;
  die $som->faultstring if $som->fault;

  $som = $wos->search('AU = (Brody)');

DESCRIPTION ^

Search and retrieve records from the Thomson Reuters ISI Web of Knowledge database.

This module is NOT backwards compatible with SOAP::ISIWoK 1.xx (deprecated WoK API). Significant changes:

  - you must now authenticate with WoK to get a session id
  - methods now return SOAP::Lite objects, use your favourite XML parser to
        parse $som->result->{records} or
  - throw an error on $som->fault

Editions

Select which editions to query. Some editions may not be available, depending on your WoS subscription.

SCI

Science Citation Index Expanded

SSCI

Social Sciences Citation Index

AHCI

Arts & Humanities Citation Index

ISTP

Conference Proceedings Citation Index - Science

ISSHP

Conference Proceedings Citation Index - Social Sciences

IC

Index Chemicus

CCR

Current Chemical Reactions

BSCI

Book Citation Index - Science

BHCI

Book Citation Index - Social Sciences and Humanities

Sort Fields

Sort results by the given field. Only relevance and times-cited may be reverse sorted, by specifying '-' in front of the sort name.

AU

Author

CF

Conference Title

CG

Page

CW

Source

CV

Volume

CY

Publication Year

LC

Local Times Cited

LD

Load Date

PG

Page

PY

Publication Year

RS / -RS

Relevance

SO

Source

TC / -TC

Times Cited

VL

Volume

Required Fields

Only return records that contain the given field(s). For example:

        fields => [qw(
                address_spec
                category_info
        )],

is logically equivalent to only showing records that contain:

        (Publisher City OR Publisher Address)
                AND
        (Web of Science Category OR Subject Category)
pub_info

Publication Type (J=Journal; B=Book; S=Series)

names

Authors, Book Authors, Group Authors, Book Group Authors, ResearcherID Number, Editors, Publisher

full_name

Author Full Name

titles

Publication Name, Book Series Title, Book Series Subtitle, 29-Character Source Abbreviation, ISO Source Abbreviation

language

Language

doctypes

Document Type

conf_title

Conference Title

conf_date

Conference Date

conf_host

Conference Host

conf_locations

Conference Location

sponsors

Conference Sponsors

keywords

Author Keywords

keywords_plus

Keywords Plus

abstract

Abstract

addresses

Author Address

reprint_contact

Reprint Address

email_addr

E-mail Address

grant

Funding Agency and Grant Number

fund_text

Funding Text

refs

Cited Reference Count

address_spec

Publisher City, Publisher Address

category_info

Web of Science Category, Subject Category

identifiers

International Standard Serial Number (ISSN), International Standard Book Number (ISBN), Book Digital Object Identifier (DOI), Article Number, Digital Object Identifier (DOI)

pub_info

Publication Date, Year Published, Volume, Issue, Part Number, Supplement, Special Issue

page

Beginning Page, Ending Page, Page Count

book_chapters

Chapter Count in a Book

ids

Document Delivery Number

UID

Accession Number

Options

        options => {
                RecordIDs => 'On',
        },
RecordIDs
        On
        Off

Return the UIDs of records as SOAP data.

METHODS ^

$wos = SOAP::ISIWoK->new( [ OPTIONS ] )

Options:

database = WOK

Database to search (WOK = all database).

collections = { WOS => [] }
        BIOABS, BCI, BIOSIS, CABI, CSCD, CCC, DIIDW, FSTA, INSPEC, MEDLINE, WOS,
        ZOOREC

The key is the Collection to search (WOS = Web of Science) and the value is a list of editions within that collection.

See Web Service documentation for the available editions, otherwise an empty array will search all editions that you are subscribed to.

$som = $wos->authenticate([$username, $password])
        die $som->faultstring if $som->fault;
        print "Session ID: ".$som->result;

Get a WoS session ID.

$som = $wos->closeSession()

Explicitly close the session with WoS. Otherwise is called when this object goes out of scope.

$som = $wos->citedReferences($uid [, OPTIONS ])
$som = $wos->citedReferencesRetrieve($queryId [, OPTIONS ])
$som = $wos->citingArticles($uid [, OPTIONS ])
$som = $wos->relatedRecords($uid [, OPTIONS ])
$som = $wos->retrieve($queryId [, OPTIONS ])
$som = $wos->retrieveById(UIDs [, OPTIONS])

UIDs is an array ref of uids.

$som = $wos->search($query [, OPTIONS])

Options:

begin - YYYY-MM-DD
end - YYYY-MM-DD
offset = 0
max = 10
sort = -RS

See "Sort Fields".

fields = []

See "Required Fields".

options = {}

See "Options"

SEE ALSO ^

SOAP::Lite

AUTHOR ^

Tim Brody, <tdb2@ecs.soton.ac.uk>

COPYRIGHT AND LICENSE ^

Copyright (C) 2013 by Tim Brody, University of Southampton (UK)

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.2 or, at your option, any later version of Perl 5 you may have available.

syntax highlighting: