Seitenhistorie
Warnung |
---|
Der Service befindet sich im Entwicklungsstadium. D.h. es wird sich noch einiges ändern, insbesondere die Struktur der Daten. |
Einführung
...
:
Ab Nuclos 4.0 hat der Nuclos Server einen RESTful Service integriert, der automatisch gestartet wird. Er dient primär als Interface für einen Webclient, kann aber auch grundsätzlich als Dienst verwendet werden.
...
Result ("total": Number, "vos": JSONArray von ValueObjects)
"total" ist die Anzahl alle Datensätze, die die Suche ohne Einschränkung der Blockgröße gefunden hat. Beispiel für ein Result-JSONObject:Codeblock {"total":4,"vos":[ {"uid":"KIb7Pmxm3AnJtdBWXWsJ","nyVRqlqCUYvH3GNwlKrn":400,"zTc3H0vtH5o2JV82gRtg":"Schraube","pk":"40000191"}, {"uid":"KIb7Pmxm3AnJtdBWXWsJ","nyVRqlqCUYvH3GNwlKrn":41,"zTc3H0vtH5o2JV82gRtg":"Stuhl","pk":"40000192"}]}
SearchResult ("uid": String, "name": String, "pk": String, "text": String)
Beispiel für ein SearchResult-JSONObject:Codeblock {"uid":"KIb7Pmxm3AnJtdBWXWsJ", "name":"Artikel" "pk":"40000217" "text":"anzahl=4, lieferung=2013-06-28, lieferbar=null, name=Schrank, preis=256.17"}
HTTP-Statuscodes:
- 200 OK
Wird von Services ohne Return-Object (z.b. Login oder Delete) zurückgegeben, wenn die Aktion erfolgreich durchgeführt worden ist. - 401 Unauthorized
Ohne oder mit ungültiger Session ID wird dieser Status gemeldet. Bei fehlgeschlagenem Login ebenfalls. - 403 Forbidden
Wird eine Aktion versucht, zu der der User keine Berichtigung besitzt (z.b. Ändern einer Entität, auf der nur Leseberechtigung besteht), kommt diese Meldung. - 404 Not Found
Wenn der Pfad des Services nicht korrekt ist, wird 404 zurückgegeben. - 406 Not Acceptable
Bei Fehlern in den JSON-Objekten (bei POST und PUT) erscheint diese Meldung.