Implementation

You only have to submit the metadata of the document viewed to the web service in order to be able to use the web service. This comprises all the further information which the Viewer needs: links to the image files, information regarding the owner of the digital representation, bibliographic information on the document and, if applicable, its structural data.

You submit the metadata in the METS format to the DFG Viewer upon calling via the parameter tx_dlf[id]. The Viewer accepts both POST and GET variables. As a result, calling can e.g. look as follows:

http://dfg-viewer.de/show/?tx_dlf[id]=http://your.library.com/mets.xml

Instead of http://your.library.com/mets.xml you insert the corresponding link to the metadata of the work in the URL. In doing so, you essentially have three possibilities of providing this information:

  1. 1. The metadata of the document is available statically, i.e. you have a specific XML file in the METS format for every title of your repository.
    In this case, you simply submit the link to the corresponding file to the DFG Viewer as in the example above:
    http://your.library.com/ppn123456789/mets.xml
  2. 2. The metadata of your repository is available in another format or database and is converted to the METS format and/ or issued by a script if required.
    After that, you submit the link to this script including all the parameters required by the script to the Viewer. Usually, this comprises at least one identifier for the desired document. Such a link could look as follows:
    http://your.library.com/mets.php?ppn=123456789
  3. 3. Your repository has an OAI interface and supports the Protocol for Metadata Harvesting (OAI-PMH) with the metadata prefix mets.
    In this case, you submit the link to this interface including the required parameters in order to get the metadata set of the desired title to the DFG Viewer in the METS format. This could for example look as follows (without return and blanks):
    http://your.library.com/oai.php?
    verb=GetRecord&identifier=123456789&metadataPrefix=mets

Please remember that all links submitted as parameters have to be URL encoded.