Info Service

These messages return general information about the server. For more information, please see http://www.cs.cornell.edu/cdlrg/dienst/protocols/DienstProtocol.htm#4.3%20Info%20Service.

 Describe Verb Describe-Verb 2.0 opt value none text/xml 200, 400

Returns a structured response that contains a list, where each element of the list provides information on a version of the specified verb that is supported by this service. The following information may be provided at the verb or version level.

  • description, description of the verb or a specific version
  • note, information pertaining to the verb or a specific version

Each element of the list contains the following information:

  • version number of the verb.
  • arguments, a list of the names of the fixed and keyword arguments, if any, accepted by the verb in that version.
  • example template of request to this repository, with fixed argument indicated in brackets
  • returns, optional, contains information about response format.

Note that a service may implement more than one version of a verb.

 Protocol=Dienst;Service=Info;ver=2.0;verb=Describe-Verb;value=List-Services <?xml version="1.0" encoding="UTF-8"?> <Describe-Verb version="2.0"> <Verb name="List-Services"> <description>List services available at this site. </description> <version id="1.0"> <example>http://cs-tr.cs.cornell.edu:80/Dienst/Info/1.0/List-Services</example> </version> </Verb> </Describe-Verb> List Verbs List-Verbs 2.0 opt none none text/xml 200, 400

Returns a structured response containing the name of the verbs defined by this service.

 Protocol=Dienst;Service=Info;ver=2.0;verb=List-Verbs <?xml version="1.0" encoding="UTF-8"?> <List-Verbs version="2.0"> <verb>Describe-Verb</verb> <verb>List-Services</verb> <verb>Identity</verb> </List-Verbs> Server Identification Identity 1.0 rep This Dienst verb is replaced by the OAI verb Identify. none none text/xml 200, 400

Returns a structured response containing information about the identity of the Dienst server.

 /Dienst/Info/1.0/Identity <?xml version="1.0" encoding="UTF-8"?> <Identity version="1.0"> <server>This Server</server> <localhost>foo.bar.com</localhost> <localport>80</localport> <maintainer>jane@bar.com</maintainer> <daylight_savings_time_zone>EDT</daylight_savings_time_zone> <standard_time_zone>EST</standard_time_zone> </Identity> Server Identification Identify 1.0 req This OAI verb is replaces by the Dienst verb Identity. none none text/xml

This verb is used to retrieve information about a repository, including administrative, identity, and community-specific information. For more information, please see: http://www.openarchives.org/OAI/openarchivesprotocol.htm#Identify.

 http://an.oa.org/OAI-script?verb=Identify

The response to this protocol request includes the following elements that must be provided by every OAI compliant repository:

  • repositoryName: a human readable name for the repository, in the example "The University of Spa E-print System";
  • baseURL: the BASE-URL of the repository;
  • protocolVersion: the version of the OAI protocol supported by the repository;
  • adminEmail: the e-mail address of the administrator of the repository.

In addition, the response may contain a list of description containers, which provide an extensible mechanism for communities to describe their repositories. The description container, could -- for instance -- be used to include collection-level metadata in the response to the Identify request. Each description container must be accompanied by the URL of an XML schema, which provides the semantics of the descriptive container. The below example of a response to the Identify request contains two description containers:

  • The oai-identifier container complies to an XML Schema, which is available at http://www.openarchives.org/OAI/oai-identifier.xsd. This schema, shown in Appendix 2, is used by repositories that choose to comply with a specific format of unique identifiers for records. The format of that identifier is explained by means of comments in the oai-identifier.xsd XML Schema.
  • The eprints container complies to an XML Schema, which is available at http://www.openarchives.org/OAI/eprints.xsd. This schema, shown in Appendix 2, has been agreed upon by the OAI e-print community, and contains information specific to repositories in that community.
 <?xml version="1.0" encoding="UTF-8"?> <Identify xmlns="http://www.openarchives.org/OAI/1.0/OAI_Identify" xmlns:xsi="http://www.w3.org/2000/10/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/1.0/OAI_Identify http://www.openarchives.org/OAI/1.0/OAI_Identify.xsd"> <responseDate>2000-10-01T19:20:30-04:00</responseDate> <requestURL>http://an.oa.org/OAI-script?verb=Identify</requestURL> <repositoryName>The University of Spa E-print System</repositoryName> <baseURL>http://an.oa.org/OAI-script</baseURL> <protocolVersion>1.0</protocolVersion> <adminEmail>mailto:adm@spa.ac.be</adminEmail> <description> <oai-identifier xmlns="http://www.openarchives.org/OAI/oai-identifier" xmlns:xsi="http://www.w3.org/2000/10/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/oai-identifier http://www.openarchives.org/OAI/oai-identifier.xsd"> <scheme>oai</scheme> <repositoryIdentifier>bespa</repositoryIdentifier> <delimiter>:</delimiter> <sampleIdentifier>oai:bespa:medi99-123</sampleIdentifier> </oai-identifier> </description> <description> <eprints xmlns="http://www.openarchives.org/OAI/eprints" xmlns:xsi="http://www.w3.org/2000/10/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/eprints http://www.openarchives.org/OAI/eprints.xsd"> <content> <URL>http://an.oa.org/info/content.htm</URL> </content> <metadataPolicy> <text>Metadata can be used by commercial and non-commercial service providers</text> <URL>http://an.oa.org/info/metadata_use.htm</URL> </metadataPolicy> <dataPolicy> <text>Full content, i.e. preprints may not be harvested by robots</text> </dataPolicy> <submissionPolicy> <URL>http://an.oa.org/info/submission.htm</URL> </submissionPolicy> </eprints> </description> </Identify> List Services List-Services 1.0 opt none none text/xml 200, 400

Returns a structured response containing the names of the defined Dienst services that are supported by this server.

Protocol=Dienst;Service=Info;ver=1.0;verb=List-Services <?xml version="1.0" encoding="UTF-8"?> <List-Services version="1.0"> <service>Repository</service> <service>Index</service> </List-Services>