Virtual Organisation:REST API Methods

From VZ Developer Wiki
Revision as of 08:59, 22 September 2010 by Pkarstedt (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Inhaltsverzeichnis, API-Methoden, Schritt für Schritt


Interface Overview

Bei POST/PUT - Requests ist folgender Header zu setzen:

   content-type: application/json; charset:UTF-8


Bei POST/PUT - Operationen ist der Request-Body folgendermaßen anzugeben:

   {"key":"value1", "key2":"value2"} 

Der Client- Request POST-Body muss im JSON Format erfolgen. Die Server-Response erfolgt ebenfalls im JSON Format (siehe: json.org). Wichtig: Sämtliche JSON-Strings müssen valide formatiert sein (d.h. Anführungszeichen müssen escapt werden, der "Content" (raw)url-encoded werden). Ob der Request erfolgreich war ist im Response-Body, in der meta-Information zu erkennen.


Server-Response nach fehlgeschlagendem Request / falscher MethodenName

{"meta":
    {
      "version":1,
      "nonce":"",
      "count":1,
      "success":false
    },
 "content":
    {
      "code":"404",
      "message":"Method getNoMethod is not implemented."
    }
}

Im Attribut "success" kommt im Fehlerfall ein "false" zurück. Weitere Informationen, wie z.B. denn http-code im Attribut "code" und ein Fehlerhinweis im Attribut "message".


Name URL HTTP method
Get Access Token https://vo.apivz.net/Api/Vo/V1/?action=token&username={username}&password={password} GET
Insert Profile https://vo.apivz.net/Api/Vo/V1/?action=profile&platform={platformId}&token={token} POST
Update Profile https://vo.apivz.net/Api/Vo/V1/?action=profile&guid={guid}&platform={platformId}&token={token} PUT
Delete Profile https://vo.apivz.net/Api/Vo/V1/?action=profile&platform={platformId}&guid={guid}&token={token} DELETE
Get categories https://vo.apivz.net/Api/Vo/V1/?action=categories&platform={platformId}&token={token} GET
Get profiles https://vo.apivz.net/Api/Vo/V1/?action=profiles&platform={platformId}&token={token} GET
Get profile information https://vo.apivz.net/Api/Vo/V1/?action=profile&platform={platformId}&guid={guid}&token={token} GET

Inhaltsverzeichnis, API-Methoden, Schritt für Schritt