RESTful API

Mögliche Parameter

GET:

/api/<namespace>/<classname>/<id>/


POST:

  • method: string
  • login: string[]
    • sessionID: string
    • securityToken: string
    • username: string
    • email: string
    • password: string
  • parameters
    • <method-parameter-name-1>
    • <method-parameter-name-2>
  • objectDecoratorClassName: string
  • apiVersion: string
  • objectIDs: integer[]


Basic Auth:

  • username: string
  • password: string

Mögliche Ausgabe

Die Ausgabe ist JSON-enkodiert.


  • request: mixed[]
  • cookie: string
  • object: mixed[]
  • decoratedObject: mixed[]
  • objectAction: mixed[]
  • result: mixed[]
  • methodResult: mixed[]
  • objectEditor: mixed[]
  • username: string
  • groupIDs: integer[]
  • languageIDs: integer[]
  • language: mixed[] - Klasse
  • hasAdministrativeAccess: integer
  • banned: integer
  • languageID: integer|null
  • sessionID: string
  • securityToken: string

Erklärung der einzelnen Elemente und Attribute

<namespace>

Dieser Parameter enthält den Namespace der Klasse, Trennzeichen ist ein /. Der Namespace kann direkt aus der Klassendatei im WSC herauskopiert werden; anschließend werden die Trennzeichen getauscht.

<classname>

Dieser Parameter enthält den Namen der Klasse. Der Wert kann direkt aus der Klassendatei im WSC herauskopiert werden.

<id>

Dieser Parameter enthält die ID des Objekts, das abgefragt werden soll. Dieser Parameter wird nur ausgewertet, wenn die Klasse von \wcf\data\DatabaseObject oder \wcf\data\DatabaseObjectDecorator erbt.

method

Dieser Parameter enthält den Namen der auszuführenden Methode und wird benötigt, wenn nicht ein DatabaseObject zurückgegeben werden soll.

login

Dieser Parameter enthält Daten zur Anmeldung des Benutzers und Validierung von dessen Zugriffsberechtigungen.

username

Dieser Parameter enthält den Benutzernamen des anzumeldenden Benutzers.

Das Benutzen der username/password-Kombination sollte nur beim Login verwendet werden, da hierdurch eine neue Session im WSC angelegt wird.

email

Dieser Parameter enthält die E-Mail-Adresse des anzumeldenden Benutzers.

Das Benutzen der email/password-Kombination sollte nur beim Login verwendet werden, da hierdurch eine neue Session im WSC angelegt wird.

password

Dieser Parameter enthält das Passwort des anzumeldenden Benutzers.

Das Benutzen der username/email/password-Kombination sollte nur beim Login verwendet werden, da hierdurch eine neue Session im WSC angelegt wird.

sessionID

Dieser Parameter enthält die ID einer dem Benutzer zugeordneten Session.

Das Benutzen ist nur nach vorherigem Login mit username/email/password oder bei Kenntnis der Session-ID und des Security-Tokens möglich.

securityToken

Dieser Parameter enthält den Security-Token einer dem Benutzer zugeordneten Session, passend zur ID der Session.

Das Benutzen ist nur nach vorherigem Login mit username/email/password oder bei Kenntnis der Session-ID und des Security-Tokens möglich.

parameters

Dieser Parameter enthält alle zur Ausführung der Methode benötigten Parameter. Der Key entspricht dem Namen der Variable, der in der Methode für den entsprechenden Parameter verwendet wird.

objectDecoratorClassName

Dieser Parameter enthält den Namespace und den Klassennamen der Klasse, in die das \wcf\data\DatabaseObject verpackt werden soll. Diese Klasse muss von wcf\data\DatabaseObjectDecorator erben.

apiVersion

Dieser Parameter enthält die erwartete Version der RESTful-API. Wird der Parameter nicht angegeben, wird die aktuellste Version verwendet.

objectIDs

Dieser Parameter enthält die IDs (integer) der Objekte, die bearbeitet werden sollen.

username

Dieser Parameter enthält den REST-API-Auth-Benutzernamen. Dieser steht in der (unsichtbaren) Option API_REST_AUTH_USERNAME.

password

Dieser Parameter enthält den REST-API-Auth-Benutzernamen. Dieser steht in der (unsichtbaren) Option API_REST_AUTH_PASSWORD.