Documents Response Field

The documents field will be populated if there are any meta documents to return. Each document has five fields:

  • hasFullText - boolean which indicates if a given document has full text available
  • inHoldings - boolean which indicates if a given document is in the current library's holdings
  • availabilityToken - optional - a string which identifies a given document's lookup key for use with the Availability API
  • openUrl - an OpenURL describing a given document
  • fields - the fields on the document. In XML format this is the only list on the document object. Therefore, the field elements are all direct children of the document

Each field in the fields list has a name and a list of values. The values may be either plain strings or a custom micro format. The micro formats are parsed in the response so even though micro formats are XML. They will be returned as JSON when response type is JSON. Some documents will have thumbnails available. Thumbnail URLs are returned in the thumbnail_s, thumbnail_m and thumbnail_l fields. Thumbnails may be referenced directly in the rendered page, and do not require another API call. If a request is made for a thumbnail that no longer exists, a redirect will be returned to a 1x1px transparent gif.

Example - A documents element in XML format

<documents>
  <document
     hasFullText="false"
     isFullTextHit="false"
     inHoldings="false">
    <field name="Language">
      <value>English</value>
    </field>
    <field name="PublicationPlace">
      <value>Chicago, Ill</value>
    </field>
    <field name="Score">
      <value>1.0</value>
    </field>
    <field name="PageCount">
      <value>1</value>
    </field>
    <field name="Copyright">
      <value>Copyright Chicago Tribune Co. Aug 3, 1980</value>
    </field>
    <field name="IsPeerReviewed">
      <value>false</value>
    </field>
    <field name="PublicationDate_xml">
      <datetime text="19800803" month="08" year="1980" day="03"/>
    </field>
    <field name="PublicationCentury">
      <value>1900</value>
    </field>
    <field name="PublicationDate">
      <value>19800803</value>
    </field>
    <field name="Copyright_xml">
      <copyright notice="Copyright Chicago Tribune Co. Aug 3, 1980"/>
    </field>
    <field name="Snippet">
      <value>RED CEDAR hand-split shakes and shingles offer many design options for an interior wallcovering that has a texture that won&apos;t quit.</value>
    </field>
    <field name="NewspaperSection">
      <value>S</value>
    </field>
    <field name="IsScholarly">
      <value>false</value>
    </field>
    <field name="ID">
      <value>FETCH-proquest_dll_6216115920</value>
    </field>
    <field name="PublicationTitle">
      <value>Chicago Tribune (1963-Current file)</value>
    </field>
    <field name="PCID">
      <value>6756202</value>
    </field>
    <field name="Genre">
      <value>article</value>
    </field>
    <field name="PublicationPlace_xml">
      <location name="Chicago, Ill"/>
    </field>
    <field name="PublicationDecade">
      <value>1980</value>
    </field>
    <field name="PQID">
      <value>621611592</value>
    </field>
    <field name="Abstract">
      <value>RED CEDAR hand-split shakes and shingles offer many design options for an interior wallcovering that has a texture that won&apos;t quit.</value>
    </field>
    <field name="ContentType">
      <value>Newspaper Article</value>
    </field>
    <field name="Title">
      <value>Outdoor coverings make a move inside</value>
    </field>
    <field name="ISSN">
      <value>1085-6706</value>
    </field>
    <field name="SSID">
      <value>ssj0016743</value>
    </field>
    <field name="StartPage">
      <value>S_A6</value>
    </field>
    <field name="link">
<value>http://demo.summon.serialssolutions.com/link/eJxtkd9q2zAUxp11G2u3vcXSG6NEkv9UMpiSJQR6UUppS8tujCYfJ0ptKZXkNM_RJ67iwGDQCyF9P33nnA8pin7RXDSEJimSBEuUUpIiJlKKJGdpSrIaMs5G0dndLFs8sutb_vRp9Lb2fltMp05k9SvrXvh-4kBYuQ6bVaJ1zrS9V0a7iTTdpfT7age2_JPwCWOIYpyeHxhoWSrdmHEyM40a02UA4fxwv0Ts3Da2UvVwXzhVT13fdUZ_OCB4fbUTbdV0_lgQ2k2DKJ5hV3R-X2xMb7VoD8bJCrSFUsOrG6TwyrdQ3vS-NsbG0oSkSq9c3IlniEXcBRArHSLA4N8c_fO1kmJl4nur_vYa4jFlhOcJmvfWgvZxo1oYUz6U1MJDSTjDCDOEk4Ep53RJMMtQfoHzAbmtWEF5V82OEvYeDqEXv68WpQ6vI_7HRgaeU5ITknF6En2m4Re_RGfObTAm-UWafI1O_034Hn3bWvPSg_M_ohH5GdY7LE6hqQ</value>
    </field>
    <isSpotlightParent>false</isSpotlightParent>
  </document>
</documents>

Example - A documents object in JSON format

[documents] => Array
        (
            [0] => Array
                (
                    [hasFullText] =>
                    [isFullTextHit] =>
                    [inHoldings] =>
                    [Language] => Array
                        (
                            [0] => English
                        )
                    [PublicationPlace] => Array
                        (
                            [0] => Boston, Mass
                        )
                    [Score] => Array
                        (
                            [0] => 1.0
                        )
                    [PageCount] => Array
                        (
                            [0] => 1
                        )
                    [Copyright] => Array
                        (
                            [0] => Copyright New York Times Company Jul 7, 1899
                        )
                    [IsPeerReviewed] => Array
                        (
                            [0] => false
                        )
                    [PublicationDate_xml] => Array
                        (
                            [0] => Array
                                (
                                    [text] => 18990707
                                    [month] => 07
                                    [year] => 1899
                                    [day] => 07
                                )
                        )
                    [PublicationCentury] => Array
                        (
                            [0] => 1800
                        )
                    [PublicationDate] => Array
                        (
                            [0] => 18990707
                        )
                    [Copyright_xml] => Array
                        (
                            [0] => Array
                                (
                                    [notice] => Copyright New York Times Company Jul 7, 1899
                                )
                        )
                    [Snippet] => Array
                        (
                            [0] => CLEVELAND, O. July 6--That the Standard oil company, as an Ohio corporation, will soon cease to exist is shown by the fact that the immense refinery plant, the ...
                        )
                    [GeographicLocations] => Array
                        (
                            [0] => CLEVELAND, O. July 6
                        )
                    [IsScholarly] => Array
                        (
                            [0] => false
                        )
                    [ID] => Array
                        (
                            [0] => FETCH-proquest_dll_5479701420
                        )
                    [PublicationTitle] => Array
                        (
                            [0] => Boston daily globe (Boston, Mass. : 1872)
                        )
                    [PCID] => Array
                        (
                            [0] => 6477782
                        )
                    [Genre] => Array
                        (
                            [0] => article
                        )
                    [PublicationPlace_xml] => Array
                        (
                            [0] => Array
                                (
                                    [name] => Boston, Mass
                                )
                        )
                    [PublicationDecade] => Array
                        (
                            [0] => 1890
                        )
                    [PQID] => Array
                        (
                            [0] => 547970142
                        )
                    [Abstract] => Array
                        (
                            [0] => CLEVELAND, O. July 6--That the Standard oil company, as an Ohio corporation, will soon cease to exist is shown by the fact that the immense refinery plant, the second largest in the world, strung along in the valley of...
                        )
                    [ContentType] => Array
                        (
                            [0] => Newspaper Article
                        )
                    [Title] => Array
                        (
                            [0] => LEAVING THE STATE OF OHIO
                        )
                    [SSID] => Array
                        (
                            [0] => ssj0043126
                        )
                    [StartPage] => Array
                        (
                            [0] => 7
                        )
                    [Subtitle] => Array
                        (
                            [0] => Standard Oil Company Abandoning Its Cleveland Plant--Official, However, Makes an Implied Denial
                        )
                    [link] => Array
                        (
                            [0] => http://demo.summon.serialssolutions.com/link/eJxtkG1vgjAQx3EPyeK2bzF804C0ILQkZNGp02TOLLKH7I2pUBQHVGlRl335VXy1ZMk1d_e7_13b07Q7D-OFS1zX8JANDceGkUFo4hh4YbkWgdSNGGxozVm303_Hkxfycdb4WUm58dttQTvxHudbcjAFo2W0Uq5MaSYEzyqZ8kKYEc_vI3mY71gZfNrExNhAluW0jowVUZAWCdftLk9SHQ0VUPFrODRwq0zKeRrXdV-kcVtUec6Lfy9QWjnf0Wye5PLUoMa1VeJ_sZ2fy4O_5lVZ0OwoNJesKFlQsL2oUypTmbHgadB9Gz8_gnA0ALOwGw7AdAimo_G0Fq1Poh4Xkhcgpmn2DZYZXzCgI3yiOnoAEyqECdQXAMQe0hGpm2MqWQAxIYblKauZ2NAlC04xO0h2fF2_N-4Has6Q_sU8UrzjeMSzoIPOtQsEkX2pNYVYq03aELnX2tWm5NuKCXmjNeCtOr98FJTO
                        )
                )
        )
)