System

Kurzbeschreibung

Ein oparl:System-Objekt repräsen­tiert eine OParl-Schnitt­s­telle für eine bestim­mte OParl-Version. Es ist außer­dem der Start­punkt für Clients beim Zugriff auf einen Server.

Möchte ein Server mehr­ere zuein­ander inkom­pat­ible OParl-Versionen unter­stützen, dann muss der Server für jede Version eine eigenen OParl-Schnitt­s­telle mit einem eigenen System-Objekt ausgeben.

Mehr…

Eigenschaften

id
JSON-Datentyp:
Format: url
type
JSON-Datentyp:
oparlVersion
JSON-Datentyp:

Die URL der OParl-Spezi­fika­tion, die von diesem Server unter­stützt wird. Aktuell kommt hier nur ein Wert in Frage. Mit zukün­fti­gen OParl-Versionen kommen weit­ere mögliche URLs hinzu. Wert: https://schema.oparl.org/1.1/

otherOparlVersions
JSON-Datentyp:
Format: url

Dient der Angabe von System-Objek­ten mit anderen OParl-Versionen.

license
JSON-Datentyp:
Format: url

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

body
JSON-Datentyp:
Format: url

Link zur Objekt­l­iste mit allen Körper­schaften, die auf dem System existieren.

name
JSON-Datentyp:

Nutzer­fre­und­licher Name für das System, mit dessen Hilfe Nutzer­innen und Nutzer das System erkennen und von anderen unter­scheiden können.

contactEmail
JSON-Datentyp:

E-Mail-Adresse für Anfra­gen zur OParl-API. Die Angabe einer E-Mail-Adresse dient sowohl Nutzer­Innen wie auch Entwick­ler­innen von Clients zur Kontak­tauf­nahme mit dem Betreiber.

contactName
JSON-Datentyp:

Name der Ansprech­part­nerin bzw. des Ansprech­part­ners oder der Abteilung, die über die in contactEmail angegebene Adresse erreicht werden kann.

website
JSON-Datentyp:
Format: url

URL der Website des parla­ment­ar­ischen Inform­a­tionssys­tems

vendor
JSON-Datentyp:
Format: url

URL der Website des Soft­warean­bi­eters, von dem die OParl-Server-Soft­ware stammt.

product
JSON-Datentyp:
Format: url

URL zu Inform­a­tionen über die auf dem System genutzte OParl-Server-Soft­ware

created
JSON-Datentyp:
Format: date-time
modified
JSON-Datentyp:
Format: date-time
web
JSON-Datentyp:
Format: url
deleted
JSON-Datentyp:

Legende

  • Zwingende Eigenschaft
  • Empfohlene Eigenschaft
{
    "id": "https://dev.oparl.org/api/v1/system/1?format=html",
    "type": "https://schema.oparl.org/1.0/System",
    "web": "https://dev.oparl.org/api/v1/system/1?format=html",
    "deleted": false,
    "created": "2017-02-26T19:31:20+01:00",
    "modified": "2017-02-26T19:31:20+01:00",
    "oparlVersion": "https://schema.oparl.org/1.0/",
    "name": "OParl Demoserver",
    "body": "https://dev.oparl.org/api/v1/body?where=system_1&format=html",
    "vendor": "http://oparl.org",
    "product": "https://dev.oparl.org/api/v1",
    "contactName": "Meinhard Berger",
    "contactEmail": "tamara52@aol.de",
    "license": "https://creativecommons.org/licenses/by-sa/4.0/",
    "website": "http://dev.oparl.org/api/v1"
}