Virtual Organisation:REST API Methods

From VZ Developer Wiki
Revision as of 08:17, 12 August 2010 by Ckloeppner (talk | contribs)
Jump to: navigation, search

Inhaltsverzeichnis, API-Methoden, Schritt für Schritt


Interface Overview

Bei POST- Requests ist folgender Header zu setzen:

   content-type: application/x-www-form-urlencoded

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

   data = {"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).

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

Inhaltsverzeichnis, API-Methoden, Schritt für Schritt