OpenDOAR logo Directory of Open Access Repositories

Application Programmers' Interface (API)

Introduction  |  Technical Manual  |  Code Lists  |  Sample Output  |  XML DTD  |  Version Changes

Appendix F - Example Output XML Record

XML header & Legal Notices

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE OpenDOAR SYSTEM "api13.dtd">
<OpenDOAR apiVersion="1.3">
  <copyright>Copyright 2007, University of Nottingham</copyright>
  <licence>OpenDOAR data is available for re-use under a Creative Commons
    Attribution-Non-Commercial-Share Alike licence</licence>

API Query Parameters & Diagnostics - Displayed when &header=y

  <header>
    <parameters>
      <parameter>
        <parametername>kwd</parametername>
        <parametervalue>xerxes</parametervalue>
      </parameter>
      <parameter>
        <parametername>show</parametername>
        <parametervalue>max</parametervalue>
      </parameter>
      <parameter>
        <parametername>header</parametername>
        <parametervalue>y</parametervalue>
      </parameter>
      <parameter>
        <parametername>multi</parametername>
        <parametervalue>phrase</parametervalue>
      </parameter>
      <parameter>
        <parametername>fields</parametername>
        <parametervalue>all</parametervalue>
      </parameter>
      <parameter>
        <parametername>bool</parametername>
        <parametervalue>AND</parametervalue>
      </parameter>
      <parameter>
        <parametername>sort</parametername>
        <parametervalue>rname</parametervalue>
      </parameter>
    </parameters>
    <numhits>1</numhits>
    <timestamp>16-Jul-2007:16:28:14</timestamp>
    <errors />
  </header>

Main repository listing

  <repositories>

Data output for all &show options - the only data output for &show=min

    <repository rID="572">
      <rName>Undergraduate theses &amp; essays from Lund University</rName>
      <rAcronym>Xerxes</rAcronym>
      <rNamePreferred>Y</rNamePreferred>
      <rUrl>http://theses.lub.lu.se/undergrad/</rUrl>
      <rOaiBaseUrl />

Additional data output for  &show=basic and &show=max options

      <uName>Lund University Digital Library</uName>
      <uAcronym />
      <uNamePreferred>Y</uNamePreferred>
      <uUrl />
      <oName>Lunds universitet</oName>
      <oAcronym />
      <oNamePreferred>Y</oNamePreferred>
      <oUrl>http://www.lu.se/</oUrl>
      <postalAddress>Lund University Libraries</postalAddress>
      <country>
        <cIsoCode>SE</cIsoCode>
        <cCountry>Sweden</cCountry>
      </country>
      <paLatitude />
      <paLongitude />
      <paPhone>046-2224005</paPhone>
      <paFax />
      <rDescription>This is an institutional repository for essays and undergraduate
        dissertations from the university. While material has been deposited by
        members from all departments there are notably more from those disciplines
        associated with the social sciences. The site interface is available in
        English or Swedish, and abstracts for materials are provided in both
        languages. An RSS feed is available for anyone interested in keeping
        up-to-date with newly added materials.&lt;br&gt;Xerxes is part of the national
        database for undergraduate essays, Uppsok, which is part of
        Libris.</rDescription>
      <rRemarks>Partners: Uppsok. Special items include: Student essays</rRemarks>
      <rNumOfItems>6292</rNumOfItems>
      <rDateHarvested>2007-07-16</rDateHarvested>

Additional data output for  &show=index and &show=max options

      <rYearEstablished />
      <repositoryType>Institutional</repositoryType>
      <operationalStatus>Operational</operationalStatus>
      <rSoftWareName />
      <rSoftWareVersion />
      <classes>
        <class>
          <clCode>C</clCode>
          <clTitle>Multidisciplinary</clTitle>
        </class>
      </classes>
      <languages>
        <language>
          <lIsoCode>en</lIsoCode>
          <lName>English</lName>
        </language>
        <language>
          <lIsoCode>sv</lIsoCode>
          <lName>Swedish</lName>
        </language>
      </languages>
      <contentTypes>
        <contentType ctID="6">Theses and dissertations</contentType>
        <contentType ctID="14">Other special item types</contentType>
      </contentTypes>

policyType & policyGrade output for  &show=index and &show=max options

      <policies>
        <policy>
          <policyType potID="1">Content</policyType>
          <policyGrade pogID="5">Content policies defined</policyGrade>

poStandard additionally output for  &show=policy and &show=max options

          <poStandard>
            <item>This is an institutional or departmental repository.</item>
            <item>The repository is restricted to: Theses and dissertations</item>
          </poStandard>
        </policy>
        <policy>
          <policyType potID="2">Metadata</policyType>
          <policyGrade pogID="8">Metadata re-use policy explicitly
            undefined</policyGrade>
          <poStandard>
            <item>Anyone may access the metadata free of charge.</item>
            <item>No metadata re-use policy defined. Assume no rights at all have been
              granted.</item>
          </poStandard>
        </policy>
        <policy>
          <policyType potID="3">Data</policyType>
          <policyGrade pogID="15">Full data item policies explicity
            undefined</policyGrade>
          <poStandard>
            <item>Anyone may access full items free of charge.</item>
            <item>No full-item re-use policy defined. Assume no rights at all have
              been granted.</item>
          </poStandard>
        </policy>
        <policy>
          <policyType potID="4">Submission</policyType>
          <policyGrade pogID="26">Submission policies defined</policyGrade>
          <poStandard>
            <item>Items may only be deposited by registered students of the
              institution</item>
            <item>No moderation policy defined. Assume nothing has been vetted.</item>
            <item>The validity and authenticity of the content of submissions is the
             sole responsibility of the depositor.</item>
            <item>No embargo policy defined.</item>
          </poStandard>
        </policy>
        <policy>
          <policyType potID="5">Preserve</policyType>
          <policyGrade pogID="28">Preservation policies not stated</policyGrade>
          <poStandard>
            <item>No preservation policy defined.</item>
          </poStandard>
        </policy>
      </policies>

Additional data output for  &show=contact and &show=max options

      <contacts>
        <person>
          <pName />
          <pJobTitle>Repository Administrator</pJobTitle>
          <pEmail>xerxes-admin@munin.lub.lu.se</pEmail>
          <pPhone />
        </person>
      </contacts>

End tags

    </repository>
  </repositories>
</OpenDOAR>

© 2006-2007, University of Nottingham, UK. Last updated: 16-Jul-2007