DBIS XML Output
Link to the interface and interface description (interactive Swagger documentation): https://dbis-api.ur.de
1. What is the DBIS XML Output for?
The XML output allows DBIS offers to be integrated into the websites of DBIS user institutions or into search portals in their own layout.
The XML interface has been adapted for the new DBIS version (release 10/2024). All endpoints that return their data as XML have been created to ensure as much backward compatibility as possible with the old DBIS system.
Tip: If you are faced with the choice of whether to use the DBIS XML output or the DBIS JSON Rest API, we recommend working with the DBIS JSON Rest API.
The new IDs for the old subject areas can be found here: https://dbis.ur.de/services
2. Input Parameters
The following parameters can be passed to the interface:
Input parameter | Value | Default value | Description |
lang | ‚de’ oder ‚en’ | ‚de’ | Select the language of the returned data. |
bib_id | / | / | The unique identifier of a participating organization, a.k.a. URL-BIBID. It is shown in the admin area. |
titel_id | / | Resource ID of the dataset that should be returned. | |
xmloutput | / | true | Must be set to 1 / true. |
include[] | licenses, description | list [licenses] | Flags for adding more information to the result. |
Suchwort | / | / | Used for textual search. |
gebiete | / | / | When querying the resources of a subject, put the subject_id or collection_id here. |
all | / | / | Include unlicensed resources if set to true. |
lett | / | / | A single letter that selects whether a subject (f) or a collection (c) is wanted. Alternatively, requests alphabetical sorting (a). |
offset | / | / | For pagiation. Pagination and sort=type are mutually exclusive. |
hits_per_page | / | / | For pagination. Pagination and sort=type are mutually exclusive. |
sort | / | / | sort=alph’ sorts the results alphabetically. This is superfluaous with the new DBIS, the results are sorted alphabetically anyway. Alternatively, specify ‘sort=type’ to group the results by type instead of alphabetical sort. Pagination and sort=type are mutually exclusive. |
db_type | / | / | Filters for one or more resource types (this parameter can be added multiple times.). The search result will only contain resources with the given db_type_id(s) |
colors | / | / | license-, access-, -type,-form) ; |
3. Status Messages
The following table provides an overview of the possible status messages that can be output by the interface.
Status-Code | Status Message (DE) | Status Message (EN) |
200 | Gibt die angeforderten Daten zurück. | Returns requested data |
403 | Wird zurückgegeben, wenn die angeforderten Daten auf „unsichtbar“ gesetzt sind. | Returned when the requested data is set to invisible |
404 | Wird zurückgegeben, wenn entweder die Ressource oder die Institution nicht gefunden wurde. | Is returned when either the resource or the institution was not found. |
4. DBIS-XML Endpoints
4.1 /detail.php
Retrieve all details about a resource—either globally or for a specific organization.
Please note that some of the XML nodes in the results are considered deprecated because they no longer correspond to the internal data structure of the new DBIS.
The deprecated nodes are: db_access_info, accesses, publisher.
Please refer to the new “licenses” node for this information instead.
Endpoint | Description |
<?xml version=”1.0″ encoding=”UTF-8″?> | |
<dbis_page xsi:noNamespaceSchemaLocation=”https://dbis.ur.de/dbinfo/scheme/dbis_page_output.xsd” version=”1.0.0″ xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”> | start of data output for this endpoint |
<library bib_id> | URL-BIBID |
<page_vars> | start |
<bib_id> | old DBIS-BIBID |
<titel_id> | resource-ID |
</page_vars> | end |
<headline> | view (detail view) |
<details> | details of the database are provided below |
<titles> | start title information |
<title main=”Y”> | official title |
<title main=”N”> | alternative title |
</titles> | end of title information |
<db_access_info access_id=”____” traffic_light=”____”> | access traffic light color |
<db_access> | access label |
<db_access_short_text> | access label usage |
</db_access_info> | start access information |
<accesses> | accesses |
<access main=”Y/N” type=”_” href=”Link”/> | main access (yes / no) access type access link |
</accesses> | end access information |
<hints> | external notes |
</hints> | end external notes |
<content> | description |
</content> | end description |
<content_eng> | description English |
</content_eng> | end description English |
<instruction> </instruction> | instructions |
<instruction_eng> </instruction_eng> | instructions English |
<licenses traffic_light=”_”> | traffic light color (green / yellow / red) |
<license id=”_” type_id=”_” form_id=”_” publication_form_title=”_” external_notes=”_”> | license ID license type ID license form ID formal type title external notes |
<access id=”_” license_id=”_” type_id=”_” main=”_” access_url=”Link” label=”_” long_label=”_” longest_label=”_” description=”_” requirements=”_”/> | access ID license ID access type ID main access (true / false) access label access label usage access label usage (long description) description requirements |
</license> | end license information |
</licenses> | end license information |
<subjects> | start subject information |
<subject collection=”_”>_</subject> | subject is collection (true / false) subject title end subject information |
</subjects> | end subject information |
<keywords> | start keyword information |
<keyword>_</keyword> | keyword |
</keywords> | end keyword information |
<appearence>_</appearence> | formal type |
<db_type_infos> | start database information |
<db_type_info db_type_id=”_”> | ID of the database type |
<db_type>_</db_type> | database type title |
<db_type_long_text>_</db_type_long_text> | database type description |
</db_type_info> | end database type information |
<publisher>_<publisher> | publisher |
</details> | end database details |
</dbis_page> | end of the delivered data from this endpoint |
4.2 /fachliste.php
Retrieve a list of all subject areas. If an organization is specified, the list also includes locally defined subject areas and collections (provided they are marked as topics).
Endpoint | Description |
<?xml version=”1.0″ encoding=”UTF-8″?> | |
<dbis_page xsi:noNamespaceSchemaLocation=”https://dbis.ur.de/dbinfo/scheme/dbis_page_output.xsd” version=”1.0.0″ xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”> | start of data output for this endpoint |
<library bib_id> | URL-BIBID |
<page_vars> | start |
<bib_id> | old DBIS-BIBID |
</page_vars> | end |
<headline> | view (detail view) |
<list_subjects_collections> | start information on subjects and collections |
<list_subjects_collections_item lett=”_” notation=”_” number=”_” subject_id=”_”>_</list_subjects_collections_item> <list_subjects_collections_item lett=”_” notation=”_” number=”_” collection_id=”_”>_</list_subjects_collections_item> | item_lett (f = subject; c = collection) notation = notation of subject title number = number of databases that are part of the subject area or collection subject_id = subject ID Collection_id = collection ID |
</list_subjects_collections> | end information on subjects and collections |
</dbis_page> | end of the data delivered by this endpoint |
4.3 /dbliste.php
This is a search function that returns a list of resource entries. Various combinations of parameters are possible:
- List all resources, either globally or from the perspective of an organization. This search mode is triggered when none of the other modes are used. In this mode, the use of pagination is recommended.
- List resources from a subject area or a collection: Use `lett=f` and `gebiete` or `lett=c` and `collid`.
- Search for resources by type: Use `db_type` with a corresponding `type_id` (or specify `sort=type` in combination with one of the previous modes to obtain a similar result).
- Free-text search (simple): Use “search term” to enter your search text.
- Free-text search (complex): The parameters jq_termN, jq_typeN, etc., allow for more complex search queries. This functionality has only been partially replicated in the new system.
Endpoint | Description |
<?xml version=”1.0″ encoding=”UTF-8″?> | |
<dbis_page xsi:noNamespaceSchemaLocation=”https://dbis.ur.de/dbinfo/scheme/dbis_page_output.xsd” version=”1.0.0″ xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”> | start of data output for this endpoint |
<library bib_id> | URL-BIBID |
<page_vars> | start |
<bib_id> | old DBIS-BIBID |
<gebiete>35</gebiete> | subject or collection ID |
<include>licenses</include> | including licenses |
<Suchwort>”_”</Suchwort> | database title sought |
<sort>alph</sort> | alphabetical sorting |
</page_vars> | end |
<headline>_</headline> | Fachgebiet |
<search_desc> | alternative title |
<search_desc_item>Suche über alle Felder: “_”</search_desc_item> | search query |
</search_desc> | end search query |
<list_dbs> | start of the list of database details |
<db_type_infos> | start database type information |
<db_type_info db_type_id=”db_type__”> | database type ID |
<db_type>_</db_type> | database type title |
<db_type_long_text>_</db_type_long_text> | database type description |
</db_type_info> | end database type information |
<dbs sort=”_” top_db=”_” db_count=”_”> | dbs sort = sorting (alph / rel) top_db = top database ID db_count |
<db title_id=”_” db_type_refs=”_” top_db=”_”> | db title_id = title ID db_type_refs top_db = top database ID |
<licenses traffic_light=”_”> | traffic light color (green / yellow / red) |
<license id=”_” type_id=”_” form_id=”_”> | license id = license ID type_id = license type ID form_id = license form ID |
<access id=”_” form_id=”_” type_id=”_” access_url=”URL”/> | access id = access ID form_id = access form ID type_id = access type ID access_url = access link |
</license> </licenses> | end license information |
</db> | end |
</dbs> | end |
</list_dbs> | end database information |
</dbis_page> | end of delivered data |
4.4 /suche.php
Retrieving various pieces of static information that may be useful to other endpoints.
Endpoints | Description |
<?xml version=”1.0″ encoding=”UTF-8″?> | |
<dbis_page xsi:noNamespaceSchemaLocation=”https://dbis.ur.de/dbinfo/scheme/dbis_page_output.xsd” version=”1.0.0″ xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”> | start of data output for this endpoint |
<library bib_id> | URL-BIBID |
<page_vars> | start |
<bib_id> | old DBIS-BIBID |
</page_vars> | end |
<headline>Suche nach Datenbanken (Erweiterte Suche)</headline> | search query |
<dbis_search> | start search query |
<option_list name=”jq_type”> | search query options |
<option value=”AL”>Suche über alle Felder</option> | search old fields |
<option value=”KT”>Titelwort(e)</option> | title word(s) |
<option value=”CO”>Beschreibung</option> | description |
<option value=”KW”>Schlagwort</option> | keyword |
<option value=”KS”>Titelanfang</option> | start title |
<option value=”PU”>Verlag</option> | publisher |
<option value=”LD”>Eingabedatum</option> | date of entry |
</option_list> | end search query options |
<option_list name=”jq_bool”> | boolean operators |
<option value=”AND”>und</option> | „and“ |
<option value=”OR”>oder</option> | „or“ |
</option_list> | end boolean operators |
<option_list name=”jq_not”> | boolean operators |
<option value=”1″/> | positive |
<option value=”NOT”>nicht</option> | negative |
</option_list> | end |
<option_list name=”gebiete”> | start subject information |
<option value=”_”>_</option> | ID and title of subject |
</option_list> | end subject information |
<option_list name=”db_types”> | start database type information |
<option value=”_”>_</option> | ID and title of database type |
</option_list> | end database type information |
<option_list name=”zugaenge”> | start access information |
<option value=”1000″/> | |
<option value=”_”>_</option> | ID and type of access |
</option_list> | end access information |
<option_list name=”formal_type”> | start formal type information |
<option value=”_”>_</option> | ID and title of formal type |
</option_list> | end formal type information |
<option_list name=”lcode”> | start country information |
<option value=”_”>_</option> | code and title of country |
</option_list> | end country information |
</dbis_search> | end search query |
</dbis_page> | end delivered data |
5. Who can I contact if I have comments or encounter errors?
Please let us know at info.dbis@ur.de if you have any further requirements that are not covered by the existing endpoints, or if you notice any errors.
There is also a mailing list for all EZB and DBIS data recipients. Here you will find service-specific information on changes, innovations, and notices of disruptions or maintenance work. You will also have the opportunity to exchange questions about the application with other data consumers, contribute your own ideas, and discuss new approaches.
Link to registration: https://www.listserv.dfn.de/sympa/info/ur-ub-ezb-dbis-data