Difference between revisions of "Virtual Organisation:REST API Methods"

From VZ Developer Wiki
Jump to: navigation, search
Line 5: Line 5:
 
Bei POST- Requests ist folgender Header zu setzen: <br>
 
Bei POST- Requests ist folgender Header zu setzen: <br>
 
     content-type: application/x-www-form-urlencoded
 
     content-type: application/x-www-form-urlencoded
 
  
 
Bei POST- Operationen ist der Request-Body folgendermaßen anzugeben: <br>
 
Bei POST- Operationen ist der Request-Body folgendermaßen anzugeben: <br>
 
     data = {"key":"value1", "key2":"value2"}  
 
     data = {"key":"value1", "key2":"value2"}  
 +
 +
Die Server Response erfolgt immer im JSON Format (siehe: [http://www.json.org/])
  
 
Wichtig: jegliche JSON-Strings müssen valide sein (z.B. Anführungszeichen escapen und Content - wenn nötig - (raw)url-encoden).
 
Wichtig: jegliche JSON-Strings müssen valide sein (z.B. Anführungszeichen escapen und Content - wenn nötig - (raw)url-encoden).

Revision as of 08:12, 12 August 2010

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"} 

Die Server Response erfolgt immer im JSON Format (siehe: [1])

Wichtig: jegliche JSON-Strings müssen valide sein (z.B. Anführungszeichen escapen und Content - wenn nötig - (raw)url-encoden).

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