Login

Der Login erfolgt auf

/

(ROOT URL des RESTful Service, z.B. http://localhost:8080/nuclos-war/rest/)

Per POST wird der Benutzername und Passwort als JSON Objekt übergeben.

{"username": "nuclos", "password": ""}

Dabei müssen folgende Request-Header gesetzt werden:

Accept:application/json
Content-Type:application/json

Als Response erhält man wieder ein JSON Objekt

{
    "links": {
        "boMetas": {
            "href": "http://localhost:8080/nuclos-war/rest/bos",
            "methods": [
                "GET"
            ]
        },
        "menu": {
            "href": "http://localhost:8080/nuclos-war/rest/meta/menu",
            "methods": [
                "GET"
            ]
        },
        "search": {
            "href": "http://localhost:8080/nuclos-war/rest/data/search/{text}",
            "methods": [
                "GET"
            ]
        },
        "tasks": {
            "href": "http://localhost:8080/nuclos-war/rest/meta/tasks",
            "methods": [
                "GET"
            ]
        }
    },
    "locale": "en_US",
    "sessionId": "07886B9397400D168EF2B49DBDB3F913",
    "username": "nuclos"
}

Mitgabe der Session ID

Jeder Service, bis auf wenige Ausnahmen (z.B. Login), benötigt eine Session ID. Wird keine Session ID übergeben, bzw. ist die Session ID ungültig, gibt der Service einen Fehler mit dem HTTP Status 401 (Unauthorized) zurück. Die Session ID kann entweder als Standard-Cookie oder als Http-Header-Parameter beim Aufruf des REST-Services übergeben werden. Der Key lautet "Cookie" und der Inhalt muss dem Schema "JSESSIONID=xxx" entsprechen, wobei xxx durch die aktuelle Session ID ersetzt werden muss.

Logout

Die URL ist identisch zum Login. Per DELETE invalidiert man die bestehende Session ID. Dieser Service gibt den HTTP Status 200 (OK) zurück, wenn die Session ID gültig war.

Ausführbares Beispiel

Siehe Beispielaufrufe per Shell