ESciDoc Interfaces

From MPDLMediaWiki
Jump to navigation Jump to search

This page gives an overview on the technical interfaces provided by PubMan.

Search&Export Interface[edit]

The Search&Export interface is a REST interface, with which one can extract data from PubMan. For the extraction the following export formats are available:

  • APA citation style
  • EndNote Export Format

The export fomats can be exported into the following output formats:

  • PDF
  • RTF
  • ODT
  • HTML
  • SNIPPET (PubMan XML format with a html snippet, in which the citation of the item in APA is written)

URL to the interface and the user friendly interface[edit]

How to search[edit]

  • Specify the index, in which you want to search, e.g. in all indexed metadata choose index: escidoc.metadata and enter the search term
    • if you want to search for more than one word, then put the search term into ".
    • you can combine the search in indexes with AND, OR, NOT
  • specify the language of the items you want to find, e.g. language=all
  • specify the export format, e.g. exportFormat=APA
  • specify the output format, e.g. outputFormat=pdf

Query examples[edit]

  • search for all items, that are submitted for publication and from the Max Planck Society: http://pubman.mpdl.mpg.de/search/SearchAndExport?cqlQuery=escidoc.dateSubmitted=200* AND escidoc.any-organizations="Max Planck Society" NOT escidoc.dateAccepted=200* NOT escidoc.published-online=200* NOT escidoc.issued=200*&exportFormat=APA&outputFormat=pdf&language=all
  • search for a certain PubMan item: http://pubman.mpdl.mpg.de/search/SearchAndExport?cqlQuery=escidoc.objid=escidoc:23018&exportFormat=APA&outputFormat=pdf&language=all
  • search for all publications from a certain department: http://pubman.mpdl.mpg.de/search/SearchAndExport?cqlQuery=escidoc.any-organizations="Department of Psychology"&exportFormat=APA&outputFormat=pdf&language=all

Technical documentation of the Search&Export Interface[edit]

The technical documentation of the Search&Export Interface can be found under: ESciDoc_Services_Search&Export

eSciDoc Import Service[edit]

The eSciDoc Import Service is a interface for harvesting data from external servers.

Operations provided[edit]

  • /unapi Gives back informations about all sources the Importhandler can fetch from.
  • /unapi/unapi Gives back informations about all formats of the eSciDoc source (which is default).
  • /unapi/unapi?id=IDENTIFIER Gives back a list of all formats for this identifier.
  • /unapi/unapi?id=IDENTIFIER&format=FORMAT Fetches the given format for this identifier.

Supported identifiers[edit]

  • identifier from a supported source (explained in /unapi). The format to fetch is defined in the &format parameter. All data will return in the fetched format.
  • identifier = any URL (the eSciDoc Import Service has no information about this source and can only try to call the given URL for the fetching request). In case of fetching from an unknown source via providing an URL the identifier is the url. As the eSciDoc Import Service can not fetch a specific format from this url the &format parameter has to be "url" to indicate that the fetching request is for an unknown source.

Link to technical documentation[edit]

If you are interested in the technical documentation, please read more on this side: ESciDoc_Services_DataAcquisitionHandler

eSciDoc Validation Service[edit]

The eSciDoc Validation Service checks XML metadata for syntactical and semantical correctness. This is done by a Schematron validation based on a given validation template that is selected by the validation schema id and the given validation point.

There are several ways to access the service. Below are links to the REST frontend and the SOAP frontend. There is also an EJB3 interface called ejb.de.mpg.escidoc.services.validation.ItemValidating.