System

Kurzbeschreibung

Ein `oparl:System`-Objekt reprä­sen­tiert eine OParl-Schnitt­stelle für eine bestimmte OParl-Version. Es ist außer­dem der Start­punkt für Clients beim Zugriff auf einen Server. Möchte ein Server mehrere zuein­an­der inkom­pa­ti­ble OParl-Versio­nen unter­stüt­zen, dann **muss** der Server für jede Version eine eige­nen OParl-Schnitt­stelle mit einem eige­nen `Sys­tem`-Objekt ausge­ben.

Mehr…

Eigenschaften

id
JSON-Datentyp:
Format: url
type
JSON-Datentyp:
oparlVersion
JSON-Datentyp:
Die URL der OParl-Spezi­fi­ka­tion, die von diesem Server unter­stützt wird. Aktu­ell kommt hier nur ein Wert in Frage. Mit zukünf­ti­gen OParl-Versio­nen kommen weitere mögli­che URLs hinzu. Wert: `https://schema.oparl.org/1.1/`
otherOparlVersions
JSON-Datentyp:
Format: url
Dient der Angabe von System-Objek­ten mit ande­ren OParl-Versio­nen.
license
JSON-Datentyp:
Format: url
Lizenz, unter der durch diese API abruf­ba­ren Daten stehen, sofern nicht am einzel­nen Objekt anders ange­ge­ben. Siehe [`licen­se`](#eigen­schaft_license).
body
JSON-Datentyp:
Format: url
Link zur [Objekt­liste](#objekt­lis­ten) mit allen Körper­schaf­ten, die auf dem System exis­tie­ren.
name
JSON-Datentyp:
Nutzer­freund­li­cher Name für das System, mit dessen Hilfe Nutze­rin­nen und Nutzer das System erken­nen und von ande­ren unter­schei­den können.
contactEmail
JSON-Datentyp:
E-Mail-Adresse für Anfra­gen zur OParl-API. Die Angabe einer E-Mail-Adresse dient sowohl NutzerIn­nen wie auch Entwick­le­rin­nen von Clients zur Kontakt­auf­nahme mit dem Betrei­ber.
contactName
JSON-Datentyp:
Name der Ansprech­part­ne­rin bzw. des Ansprech­part­ners oder der Abtei­lung, die über die in `con­tac­tE­mail` ange­ge­bene Adresse erreicht werden kann.
website
JSON-Datentyp:
Format: url
URL der Website des parla­men­ta­ri­schen Infor­ma­ti­ons­sys­tems
vendor
JSON-Datentyp:
Format: url
URL der Website des Soft­wa­rean­bie­ters, von dem die OParl-Server-Soft­ware stammt.
product
JSON-Datentyp:
Format: url
URL zu Infor­ma­tio­nen ü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/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"
}