3. Basic information on accessing the EZB services

All EZB services are processed via HTTP GET requests following this structure: https://ezb.ur.de/<script name>.phtml?bibid=UBR&colors=7&lang=de&…<script specific parameters>…&xmloutput=1

Since the EZB manages the licence data of 669 participating institutions, the result of an EZB service call depends on the currently selected view. The choice of the current view is determined by the parameters bibid, client_ip, colors and lang when the service is called up.

The current values of the parameters bibid, colors and lang are transferred in the XML response and should be used for further requests.

The parameter colors is used to select which journal entries are to be displayed. The value 1 stands for journals with freely accessible full-text articles, 2 for journals where access to full-text articles is licenced for the respective institution and 4 for journals where full-text articles cannot be accessed. By summing up the values any combination is possible, the default value is 7 (for all journals).

The parameter lang determines which language is used in the XML response. Possible values are de for German and en for English, the default setting is de. If an EZB participant has not configured an English view, the system switches to German.

For the output of the search results a new version of the XML schema was created, which contains the exact hits. You can get the new version of the XML output if you add the parameter &xmlv=3 (XML-Version 3) in the URL.

Detail page

For the detailed edition a new version of the XML schema was created, which contains the DOAJ link of green magazines. The new version of the XML output can be obtained by adding the parameter &xmlv=2 (XML-Version 2) in the URL.

XML-example: LINK

Content of the element page_vars: notation / sc, lc for scrolling by first letter, if > 50 (default) journals / sindex for scrolling in the list for a first letter
Content of the ezb_alphabetical_list element: Element subject with the attribute notation, the content is the name of the subject.
Element navlist with child elements current_page and other_pages to browse by letter
Element(s) first_fifty to browse in the list for the current initial letter
Element alphabetical_order, per journal one child element journals with attribute jour_id (internal EZB-ID of the journal) and child elements title, journal_color, detail_link (-> link to detail view: detail with jour_id), warpto_link (-> link to journal: warpto with jour_id) and (for yellow and yellow-red traffic lights (= licencing)) the readme_link (-> link to the readme page: show_readme with jour_id), journal_new (= if a new entry is younger than 7 days).
Element(s) next_fifty to scroll in the list to the current initial letter
Element contact for a contact person of the respective subject.

XML-example: LINK

Content: Details of the selected journal (via the alphabetical list)
Parent element: ezb_detail_about_journal
Further parameters: Summarized under page_vars: jour_id

Content of the element ezb_detail_about_journal: Child element journal

Content of the element journal:
title (journal title), journal_color (licencing color (red-yellow-green), with attr. color_code), readme_link if yellow (with licence information about the publisher, with attr. url), warpto_link if yellow, green, red (with link to the homepage of the journal or the publisher), where_link (information about where licences exist for the selected journal), periods if yellow-red (information about licence periods, etc.), detail with child elements.

Content of the child element periods (of journal):
period with journal_color (only yellow or red), label (for yellow), warpto_link with attribute url (urlencoded), readme_link with attribute url for yellow (direct link to the readme page).

Content of the child element detail (of journal):
publisher, E_ISSN (EISSN-number) with parent element E_ISSNs, P_ISSN (PISSN-number) with parent element P_ISSNs, ZDB_number (ZDB-Number with attr. url), subject (subject area (-group)), with parent element subjects, keyword with parent element keywords, first_fulltext_issue with child elements first_volume, first_issue and first_date; last_fulltext_issue with child elements last_volume, last_issue and last_date; access (e.g. http)), formate (e.g. pdf), fulltext (fulltext-Url with attr. url), homepages -> homepage (Homepage of the journal with attr. url), first_issue, last_issue, moving_wall (moving wall time period), appearence, costs, pay_per_view with the child element suppliers and its child element supplier, supplier_url (attribute url) and first_date and last_date (all belonging to the pay-per-view option); journal_access (access with attr. url), remarks.
Additionally available for “ebsco”:
fulltext_articles.
Additionally available for “proquest”:
article_text (first, last article), scanned_articles (…also scanned), text_graphics (first, last picture or graphic).

XML-example: LINK (green)
XML-example: LINK (yellow-red)
XML-example: LINK (yellow)
XML-example: LINK (red)

Content: A direct link to the homepage of the journal/article (‘normal case’). The ‘special case’ of the yellow-red traffic light, contains a link to an EZB intermediate page, which gives information about the periods the journal is licenced for. Links are also listed there, which can be linked to the journal via warpto_link with the attribute url. If necessary, a link to the readme file of the publisher’s licence terms and conditions is also provided.

parent element: ezb_warpto_journal
Normal: journal (with the attribute jourid) and location with the link to the journal. (-> direct linking)
Special case:journal (with the attribute jourid) and the child elements title and periods (cf. detail)

XML-example ‘normal’: LINK
XML-example ‘special case’: LINK

Content: Licencing is reflected in the EZB by yellow (yellow-red) traffic lights. For the journals concerned, the licencing conditions may vary from publisher to publisher. These can be accessed through the ”Readme” link.
Parent element: ezb_readme_page
Further parameters: journal (with the attribute jourid) and location which always contains the link to the readme page.
Alternatively:
noreadme (all non-yellow cases) or alternatively, if multiple licence periods exist for a journal:
journal (with the attribute jourid) and the child elements title and periods and location (cf. detail)

XML-example: LINK for Noreadme
XML-example: LINK for Readme
XML-example: LINK for several Readmes

Content: The search function (Journals/Journal Search) contains various search input options for finding journals. The structure of the search mask uses the parameters in page_vars:

In each case with content for prefilling the fields (under “Refine search”).

Parent element: ezb_search:
This contains the option option_list and its child element option:
The following contents can occur for the attribute name contained in option_list and the attribute value used in option:

<option_list name="jq_type"> with the possibilities:
<option value="KT">title word(s)</option>
<option value="KS">start of title;/option>
<option value="KW">keyword(s)</option>
<option value="PU">publisher</option>
<option value="IS">ISSN</option>
<option value="ID">date of entry</option>
<option value="LC">last change</option>
<option value="ZD">ZDB number</option>
<option_list name="jq_bool"> with the possibilities:
<option value="AND"></option>
<option value="OR"></option>
<option_list name="jq_not"> with the possibilities:
<option value=" "/>
<option value="NOT"></option>
<option_list name="offset">
<option value="-1" selected="true">alphabetic</option>
<option value="0">scroll</option>
<option_list name="hits_per_page">
with various selection options for the number of hits per page
<option_list name="Notations" multiple="true">
with a list of the subjects; for (multiple) selection(s)
<option_list name="selected_colors" multiple="true">
with a list of the "traffic light colours" to be displayed

Attention:

• Notations and selected_colors must be requested with []
• in a request to refine the search, the values last used in offset, hits_per_page, notations and selected_colors are given the attribute selected=”true”.

XML-example: LINK

Contents: Search results are presented as an alphabetical list as in fl or for scrolling by page.
Parent element: ezb_alphabetical_list_searchresult
As in the search mask, the parameters of the page_vars are decisive:

Attention:

• Notations must be accessed with []

The structure of fl similar to (sc, sindex), hits_per_page adjustable, or alternatively through scrolling with hits_per_page, then navlist with first_page, previous_page, next_page, last_page each with the attribute offset.

current_page with content [from – to]
XML-example: LINK

Contents: List of all participating institutions.
Parent element: ezb_partner_selection with child elements:

• countries
  With a list of country; Attribute ID and lang with the content country name.
• categories
  With a list of category; Attribute ID, lang and country_refs with the contents of the name of the category. Also attribute countryrefs (ID’s of the countries, in which the category occurs).
• institutions
  With a list of institution; Attribute ID (bibid of the institution), lang, catrefs and countryref
  Explanation: catrefs = categories in which the institution belongs; countryref = country, sorted by city, name of the institution.

Also an option_list as in:
<option_list name="selected_colors" multiple="true"> with a list of the "traffic light colors" to be displayed and child element option for the 'traffic light texts':
<option value="1" selected="true">freely accessible/option>
<option value="2" selected="true">for members of the University of Regensburg in the university network free, access conditions in the Readme</option>
<option value="4" selected="true">not accessible for members of the University of Regensburg...</option>

XML-example: LINK

Content: List of participating institutions providing full text access to a journal.
Parent element: ezb_where_journal_at_partners with child elements: journal and attribute jourid, and its child element title
Further child elements of ezb_where_journal_at_partners: partner_selection
As under select (ezb_partner_selection) with child elements countries, categories and institutions.
Further parameters under page_vars: jour_id

XML-example: LINK

Content: Lists contact addresses (e-mail, homepage).
Parent element: ezb_contact with the attribute href for the link to the contact person and the corresponding link title.

XML-example: LINK