System

Kurzbeschreibung

Ein oparl:System-Objekt repräsentiert eine OParl-Schnittstelle für eine bestimmte OParl-Version. Es ist außerdem der Startpunkt für Clients beim Zugriff auf einen Server.

Möchte ein Server mehrere zueinander inkompatible OParl-Versionen unterstützen, dann muss der Server für jede Version eine eigenen OParl-Schnittstelle mit einem eigenen System-Objekt ausgeben.

Mehr…

Eigenschaften

Feldname JSON Datentyp Beschreibung
id
type
oparlVersion

Die URL der OParl-Spezifikation, die von diesem Server unterstützt wird. Aktuell kommt hier nur ein Wert in Frage. Mit zukünftigen OParl-Versionen kommen weitere mögliche URLs hinzu. Wert: https://schema.oparl.org/1.0/

otherOparlVersions

Dient der Angabe von System-Objekten mit anderen OParl-Versionen.

license

Lizenz, unter der durch diese API abrufbaren Daten stehen, sofern nicht am einzelnen Objekt anders angegeben. Siehe license.

body

Link zur Objektliste mit allen Körperschaften, die auf dem System existieren.

name

Nutzerfreundlicher Name für das System, mit dessen Hilfe Nutzerinnen und Nutzer das System erkennen und von anderen unterscheiden können.

contactEmail

E-Mail-Adresse für Anfragen zur OParl-API. Die Angabe einer E-Mail-Adresse dient sowohl NutzerInnen wie auch Entwicklerinnen von Clients zur Kontaktaufnahme mit dem Betreiber.

contactName

Name der Ansprechpartnerin bzw. des Ansprechpartners oder der Abteilung, die über die in contactEmail angegebene Adresse erreicht werden kann.

website

URL der Website des parlamentarischen Informationssystems

vendor

URL der Website des Softwareanbieters, von dem die OParl-Server-Software stammt.

product

URL zu Informationen über die auf dem System genutzte OParl-Server-Software

created
modified
web
deleted

Legende

  • Zwingende Eigenschaft
  • Empfohlene Eigenschaft
{
    "id": "https://dev.oparl.org/api/oparl/v1/system/1",
    "type": "https://schema.oparl.org/1.0/System",
    "web": "https://dev.oparl.org/api/oparl/v1/system/1",
    "deleted": false,
    "created": "2017-05-08T10:46:55+02:00",
    "modified": "2017-05-08T10:46:55+02:00",
    "oparlVersion": "https://schema.oparl.org/1.0/",
    "name": "OParl Demoserver",
    "body": "https://dev.oparl.org/api/oparl/v1/body?where=system_1",
    "vendor": "http://oparl.org",
    "product": "https://dev.oparl.org/api/oparl/v1",
    "contactName": "Nils Bertram",
    "contactEmail": "elena.niemann@yahoo.de",
    "license": "https://creativecommons.org/licenses/by-sa/4.0/",
    "website": "http://localhost"
}