Dies ist die ursprüngliche xepicur Dokumentation. Bei dieser ist die aktuelle Umsetzung beim Ingest in den URN-Service nicht berücksichtigt.
Die ergänzte und kommentierte referenzbeschreibung Referenzbeschreibung finden Sie hier.
Inhalt | ||||
---|---|---|---|---|
|
Generelle Hinweise
Gültigkeit:
Für Datensätze zur Administration von URNs ist xepicur zukünftig nur mehr für die Übertragungsart OAI-PMH verbindlich.
Hinweise zu Datenstruktur und Syntax
Für den Datensatz ist als Dokumentformat XML verbindlich.
- Elementtypen
Der Metadatensatz enthält Datenelemente, die nach Elementtypen differenziert in strukturierter Form angegeben sind. Jedes Datenelement wird durch einen Elementbezeichner (tag) eingeleitet, der den Elementnamen angibt.
- Beispiel:
- <identifier>
- Attribute
- Elementbezeichner werden durch Attribute spezifiziert. Es wurden obligatorische Attribute ("type", "scheme", "imt") und optionale Attribute ("role", "status" oder "type") definiert.
- Beispiel: <identifier scheme="url" role="primary">
Beschreibung des Datenformates, Reihenfolge und Struktur der Elemente
Generelle Struktur
Ein XML-Datensatz besteht aus einem Wurzelelement
<epicur>
und zwei hierarchisch untergeordneten Elementen
<administrative_data>
<record>
Wurzelelement "epciur"
Bezeichnung | epicur | wird ausgewertet|||
---|---|---|---|---|
Attribute | keine | |||
Unterelemente |
| |||
Wiederholbar | nein | |||
Obligatorisch | ja | |||
Beschreibung | Das Wurzelelement bildet die äußere Einheit eines XML-Dokumentes. | |||
Syntax | <epicur> <administrative_data> [...] </administrative_data> <record> [...] </record> < /epicur> |
Elementgruppe "administrative_data"
Element "administrative_data"
Bezeichnung | administrative_data | wird ausgewertet | |
---|---|---|---|
Attribute | keine | ||
Unterelemente |
| ||
Wiederholbar | nein | ||
Obligatorisch | ja | ||
Beschreibung | Das Element dient der Kapselung von Legitimationsdaten, der Spezifizierung des URN-Meldeprozesses, der verwendeten Transferschnittstelle sowie der Art der Rückmeldung. | ||
Syntax | <administrativ_data> <delivery> | [...] </delivery> < | /administrative_data> |
Element "authorization"
Bezeichnung | authorization | wird nicht mehr ausgewertet. Bitte nicht mehr verwenden |
---|---|---|
Attribute | keine | |
Unterelemente |
| |
Wiederholbar | nein | |
Obligatorisch | nein | |
Beschreibung | Die Informationen dienen der Spezifizierung des URN-Meldeprozesses wie z.B. URN-Erstmeldung oder URL-Aktualisierung, der verwendeten Transferschnittstelle oder der Art der Rückmeldung. | |
Syntax | <administrative_data> <delivery> <authorization> <person_id>F6000123</person_id> <urn_snid>urn:nbn:de:089</urn_snid> </authorization> </delivery></administrative_data> |
Element "update_status"
Bezeichnung | update_status | wird nicht ausgewertet, da es aber obligatorisch ist, bitte mit beliebigem Attribut verwenden. |
---|---|---|
Attribute | "type" mit folgenden Inhalten: | |
| wird nicht ausgewertet | |
| wird nicht mehr ausgewertet. | |
| wird nicht mehr ausgewertet. | |
| wird nicht mehr ausgewertet. | |
| wird nicht mehr ausgewertet. | |
| wird nicht mehr ausgewertet. | |
| wird nicht mehr ausgewertet. | |
Unterelemente | keine | |
Wiederholbar | nein | |
Obligatorisch | ja | |
Beschreibung | Das Element dient der Spezifizierung der Art des Meldeprozesses | |
Syntax | <update_status type="urn_new"/> |
Element "transfer"
Bezeichnung | transfer | wird nicht mehr ausgewertet. Bitte nicht mehr verwenden |
---|---|---|
Obligatorisch | nein |
Element "resupply"
Bezeichnung | resupply | wird nicht mehr ausgewertet. Bitte nicht mehr verwenden |
---|---|---|
Obligatorisch | nein |
Beispiel "administrative_data"
<epicur> | |||||
<administrative_data> | |||||
<delivery> | |||||
<update_status type="urn_new"/> | |||||
</delivery> | |||||
</administrative_data> | |||||
[...] | |||||
<epicur> |
Elementgruppe "record"
Element "record"
...
Bezeichnung | identifier | wird ausgewertet |
---|---|---|
Attribute |
Mit dem Attribut "scheme" wird URN bzw. URL des Objektes erfasst. Das Attribut zur Spezifizierung der URN kann folgende Werte annehmen: "urn" "urn:nbn" "urn:nbn:de" "urn:nbn:at" "urn:nbn:ch" Das Attribut zur Spezifizierung der URL hat folgenden obligatorischen Wert: "url Das Attribut zur Spezifizierung der URN kann folgende Werte annehmen: "urn" "urn:nbn" "urn:nbn:de" "urn:nbn:at" "urn:nbn:ch" und zusätzlich folgende optionale Attribute: | wird ausgewertet |
| wird nicht mehr ausgewertet. Bitte nicht mehr verwenden | |
| wird nicht mehr ausgewertet. Bitte nicht mehr verwenden | |
Das optionale Attribut kennzeichnet eine URL als "Master-URL", die beim Resolving zuerst ausgewiesen werden soll. Dieser Fall tritt ein, wenn mehr als eine URL zu einer URN registriert ist. Das Attribut hat folgenden Wert:
| wird ausgewertet | |
"origin" | wird nicht mehr ausgewertet. Bitte nicht mehr verwenden | |
"target" | wird nicht mehr ausgewertet. Bitte nicht mehr verwenden | |
Unterelemente | keine | |
Wiederholbar | ja | |
Obligatorisch | ja | |
Beschreibung | Das Element "identifier" enthält Informationen über eine URN und URL. Es wird durch obligatorische sowie mehrere optionale Attribute näher spezifiziert. | |
Syntax (Auswahl) | <identifier scheme="urn:nbn:de">
|
Element "isVersionOf"
Bezeichnung | isVersionOf | wird nicht mehr ausgewertet. Bitte nicht mehr verwenden |
---|---|---|
Obligatorisch | nein |
Element "hasVersion"
Bezeichnung | hasVersion | wird nicht mehr ausgewertet. Bitte nicht mehr verwenden |
---|---|---|
Obligatorisch | nein |
Element "resource"
Bezeichnung | resource | wird ausgewertet | |
---|---|---|---|
Attribute | keine | ||
Unterelemente |
| wird ausgewertet | |
| wird | nicht mehrausgewertet | . Bitte nicht mehr verwenden|
Wiederholbar | ja | ||
Obligatorisch | nein | ||
Beschreibung | Das Element "resource" kapselt die Unterelemente "identifier" mit dem Attribut scheme="url" und "format" dient der Erfassung der URL und des MimeTypes (Dateiformat) des Objektes. | ||
Syntax | <resource> </format> |
Element "format"
Bezeichnung | format | ??????? | ||
---|---|---|---|---|
Attribute | Das Element "format" hat folgendes Attribut: "imt", das als Wert den MimeType des Objektes enthält. | |||
Unterelemente | ||||
Wiederholbar | ||||
Obligatorisch |
Element "isPartOf"
Bezeichnung | isPartOf | URN und URL werden registriert, die hierarchische Struktur wird ignoriert. |
---|---|---|
Attribute | ||
...