Seitenhistorie

...

• Login (Path: /login, Method: POST, Return: String)
  Erwartet ein JSON-Objekt mit den Logindaten ("locale" ist optional), authentifiziert sich damit am Nuclos-Server und gibt eine SessionID als String zurück. Die Session ID benötig wird um alle anderen Teilservices zu verwenden. Schlägt der Login fehl, wird ein Fehler mit dem HTTP Status 401 (Unauthorized) zurückgeworfen. Beispiel für ein gültiges JSON-Objekt unter JavaScript:

  Codeblock
  var login = {"username": "user123", "password": "passXYZ", "locale": "de_DE"};

• Logout (Path: /logout, Method: GET)
  Invalidiert die bestehende Session ID. Diese Methode gibt den HTTP Status 200 (OK), wenn die Session ID gültig war.
  
  
• Entities (Path: /meta/entities, Method: GET, Return: JSON-Array)
  Liefert alle Entitäten zurück, auf die der Benutzer lesend zugreifen kann.
  
  
• LoadData (PathsPath: /data/load/{uid}, /data/load/{uid}/{offset}, MethodMethods: GET/POST, Return: JSON-Array)
  Die Mit GET werden die ersten 1000 Datensätze der Entität {uid} werden geladen. Falls die Option {offset} gegeben ist, wird ab diesem Datensatz begonnengeladen. Mit POST kann ein Filter (s. JSON-Spezifikationen) übergeben werden.
  
  
• GetData (Path:/data/get/{uid}/{pk}, Method: GET, Return: JSON-Array mit 1 oder 0 Elementen)
  Es wird der Datensatz der Entität {uid} mit dem Primärschlüssel {pk} zurückgegeben, falls er existiert.
  
  
• Search (Path: /data/search/{text}, Method: GET, Return: JSON-Array)
  Durchsucht die Entitäten nach dem Suchtext {text} mit Hilfe des Lucene-Indexes.
  
  
• Count (Path: /data/count/{uid}, Method: GET/POST, Return: Number)
  Zählt die Anzahl der Datensätze der Entität {uid}. Mit POST kann ein Filter (s. JSON-Spezifikationen) übergeben werden.
  
  

JSON-Spezifikationen

• Filter ("search": String, "offset": Number, "chunksize": Number, "sort": String)
  Beispiel für ein gültiges Filter-JSON-Objekt:

  Codeblock
  var filter = {"search": "Hu", "offset": 0, "chunksize": 100, "sort": "szU1s75TFT6kGF7l0Whj=asc"};