OCLC Developer Network

Response Details

Identity Document

Example Identity Document

Fields

  • type - type of name (personal, corporate, subject, abandoned)
  • creationtime - time the Identity record was created
  • pnkey - key associated with the record
  • biogSHs - a list of biographical subject headings along with the number of works for that Identity
  • audLevel - audience level of the works related to identity. Works are listed in from lowest to highest audience level
  • authorityInfo - Name authority information if it exists
  • associatedNames - list of names found with the Identity in WorldCat records
  • nameInfo - extensive information about the identity
    • rawName - non-Latin form of name if exists
    • latinName - Latin form of name
    • tag - MARC field in which the name is most often found
    • genres - Genres associated with this name along with the count of holdings with each specific genre
    • fastHeadings - FAST headings associated with this name along with the count of holdings with each specific heading
    • languages - languages associated with this name along with the count of holdings with each specific language
    • birthDate - birth date for personal names
    • deathDate - death date for personal names
    • dates - list of years in which works by or about the identity were published
    • totalHoldings - total holdings associated with this name
    • recordType -
    • ddc - Most commonly found Dewey Decimal Classification number found (weighted by holdings)
    • lcc - Most commonly found Library of Congress Classification number found (weighted by holdings)
    • relators - list of relator codes associated with Identity and number of works with that relator
    • workCount - number of works associated with identity
    • recordCount - number of records associated with identity
    • fictionCount - number of fiction works? associated with this identity
  • by - works by the identity
  • about - works about the identity
  • bestCover - identifiers for the record with the most holdings and cover art

Name Finder Results

nameAuthorities Fields

  • query - query sent
  • maxlist - maximum results returned
  • hitCount - total number of results

Match Record Fields

  • type - type of name match (ExactMatchesWithDates, ExactMatches, ExactNameParts, FuzzyFirstName, FuzzyFamilyName, FuzzyName, FreeTextName )
  • usage - how often this form of name used
  • score - score for this form of name
  • establishedForm - Best version of the name of display purposes
  • uri - Relative URL to get the Identity being described
  • key - Unique key part of the URI. In case one needs to access that Identity in a different context
  • lccn - Library of Congress Control Number
  • citation - Title of the most highly held work in WorldCat associated with that Identity
  • pubDates - Dates of associated holdings
  • nameType - type of name (personal, corporate)


Example

<nameAuthorities query="levan, ralph" maxList="10" hitCount="75">
  <match type="ExactNameParts" usage="8" score="2000">
    <establishedForm>LeVan, Ralph R.</establishedForm>
    <uri>/identities/np-levan, ralph r</uri>
    <key>np-levan, ralph r</key>
    <citation>An architecture for scholarly publishing on the World Wide Web</citation>

    <pubDates>1994-2005</pubDates>
    <nameType>personal</nameType>
    </match>
...
</nameAuthorities>

SRU Results

SRU search results are made up of Identity records wrapped in an SRU response format.

Truncated example

<?xml version="1.0" ?> 
<?xml-stylesheet type="text/xsl" href="/identities/NameFinderResponse.xsl"?>
<searchRetrieveResponse xmlns="http://www.loc.gov/zing/srw/">
    <version>1.1</version>
    <numberOfRecords>5</numberOfRecords>
    <resultSetId>ukx6n5</resultSetId>
    <resultSetIdleTime>300</resultSetIdleTime>
    <records xmlns:ns1="http://www.loc.gov/zing/srw/">
        <record>
            <recordSchema>info:srw/schema/1/Identities</recordSchema>
            <recordPacking>xml</recordPacking>
            <recordData>
                <Identity type="personal" xmlns="">
                ...
                </Identity>
            </recordData>
            <recordPosition>1</recordPosition>
        </record>
...
    </records>
    <echoedSearchRetrieveRequest xmlns:ns2="http://www.loc.gov/zing/srw/">
        <version>1.1</version>
        <query>local.FamilyName = "Coombs" and local.FirstName =
            "Karen"</query>
        <xQuery>
            <ns3:triple xmlns:ns3="http://www.loc.gov/zing/cql/xcql/">
                <ns3:boolean>
                    <ns3:value>and</ns3:value>
                </ns3:boolean>
                <ns3:leftOperand>
                    <ns3:searchClause>
                        <ns3:index>local.FamilyName</ns3:index>
                        <ns3:relation>
                            <ns3:value>=</ns3:value>
                        </ns3:relation>
                        <ns3:term>Coombs</ns3:term>
                    </ns3:searchClause>
                </ns3:leftOperand>
                <ns3:rightOperand>
                    <ns3:searchClause>
                        <ns3:index>local.FirstName</ns3:index>
                        <ns3:relation>
                            <ns3:value>=</ns3:value>
                        </ns3:relation>
                        <ns3:term>Karen</ns3:term>
                    </ns3:searchClause>
                </ns3:rightOperand>
            </ns3:triple>
        </xQuery>
        <startRecord>1</startRecord>
        <maximumRecords>10</maximumRecords>
        <recordPacking>xml</recordPacking>
        <recordSchema>info:srw/schema/1/Identities</recordSchema>
        <resultSetTTL>300</resultSetTTL>
        <sortKeys/>
    </echoedSearchRetrieveRequest>
    <extraResponseData xmlns:ns4="http://www.loc.gov/zing/srw/">
        <ns5:extraData xmlns="http://oclc.org/srw/extraData"
            xmlns:ns5="http://oclc.org/srw/extraData">
            <ns5:databaseTitle>WorldCat Personal Identity Records</ns5:databaseTitle>
        </ns5:extraData>
    </extraResponseData>
</searchRetrieveResponse>

AutoSuggest Results

{
    "query": "dempsey",
    "result": [
        {
            "term": "Dempsey, Henry Maxwell, 1925-",
            "arn": "oca00302863",
            "lccn": "n79-70047"
        },
        {
            "term": "Dempsey, Patrick, 1966-",
            "arn": "oca03898989",
            "lccn": "n95-81250"
        },
        {
            "term": "Dempsey, Paul (Paul K.)",
            "arn": "oca00289124",
            "lccn": "n79-56017"
        },
        {
            "term": "Dempsey, Hugh Aylmer, 1929-",
            "arn": "oca00298216",
            "lccn": "n79-65296"
        },
        {
            "term": "Dempsey, Jack, 1895-1983",
            "arn": "oca00297863",
            "lccn": "n79-64938"
        },
        {
            "term": "Dempsey, Michael W",
            "arn": "oca00071454",
            "lccn": "n50-36190"
        },
        {
            "term": "Dempsey, Richard",
            "arn": "oca04756696",
            "lccn": "no98-93445"
        },
        {
            "term": "Dempsey, Charles",
            "arn": "oca00175479",
            "lccn": "n78-39512"
        },
        {
            "term": "Dempsey, Sean"
        },
        {
            "term": "Dempsey, Paul Stephen",
            "arn": "oca01341801",
            "lccn": "n85-105883"
        }
    ]
}

Follow the OCLC Developer Network:

The OCLC Developer Network supports the use of OCLC Web Services—a set of tools and APIs that expose data and services for WorldCat and our member libraries and partner institutions or companies. learn more »

© 2010 OCLC Domestic and international trademarks and/or service marks of OCLC Online Computer Library Center, Inc. and its affiliates


Powered by Drupal, an open source content management system