Difference between revisions of "Virtual Organisation:Edelprofil mittels REST API anlegen"

From VZ Developer Wiki
Jump to: navigation, search
m
m
 
Line 12: Line 12:
 
       https://vo.apivz.net/Api/Vo/V1/?action=profile&platform=1&token=c11ecf449fb37e653c4dd3c66c1dcb104fbfe22b
 
       https://vo.apivz.net/Api/Vo/V1/?action=profile&platform=1&token=c11ecf449fb37e653c4dd3c66c1dcb104fbfe22b
  
* Für das Anlegen von Edelprofilen bei schülerVZ muss folgende AnfragenURL benutzt werden.
+
* Für das Anlegen von Edelprofilen bei schülerVZ ist lediglich der Platformparameter entscheidend.
 
* Dabei ist der Parameter "platform" mit 2  zu belegen.
 
* Dabei ist der Parameter "platform" mit 2  zu belegen.
 
       https://vo.apivz.net/Api/Vo/V1/?action=profile&platform=2&token=c11ecf449fb37e653c4dd3c66c1dcb104fbfe22b
 
       https://vo.apivz.net/Api/Vo/V1/?action=profile&platform=2&token=c11ecf449fb37e653c4dd3c66c1dcb104fbfe22b
  
* in der Beispielanfrage ist der Parameter "platform" mit "1" gesetzt. Dadurch wird ein Edelprofil auf studiVZ angelegt.
+
* ist der Parameter "platform" mit "1" gesetzt, wird dadurch ein Edelprofil auf studiVZ angelegt.
 
* dieses Edelprofil ist ebenfalls über meinVZ zu sehen, jedoch nicht über schülerVZ.
 
* dieses Edelprofil ist ebenfalls über meinVZ zu sehen, jedoch nicht über schülerVZ.
  

Latest revision as of 08:14, 22 September 2010

Schritt für Schritt | <= vorheriger Schritt 2 | Schritt 3 | nächster Schritt 4 =>



Mit einem gültigen Token können Sie jetzt z. B. ein Edelprofil bei studiVZ/meinVZ oder bei schülerVZ anlegen, editieren oder wieder löschen. Es ist zu beachten, dass eine strikte Trennung der Plattformkombinationen studiVZ/meinVZ und schülerVZ gemacht werden. Ein bei studiVZ/meinVZ angelegtes Edelprofil ist automatisch bei der jeweils anderen Plattform existent. Wohingegen ein Objekt im schülerVZ nur dort sichtbar ist. Somit müssen Sie bei allen Operationen eine Plattform-ID angeben. In dem folgenden Beispiel geht es darum ein Edelprofil anzulegen.


Beispiel:

  • um ein Edelprofil anzulegen muss die Anfrage mit der Methode POST abgesetzt werden.
      https://vo.apivz.net/Api/Vo/V1/?action=profile&platform=1&token=c11ecf449fb37e653c4dd3c66c1dcb104fbfe22b
  • Für das Anlegen von Edelprofilen bei schülerVZ ist lediglich der Platformparameter entscheidend.
  • Dabei ist der Parameter "platform" mit 2 zu belegen.
      https://vo.apivz.net/Api/Vo/V1/?action=profile&platform=2&token=c11ecf449fb37e653c4dd3c66c1dcb104fbfe22b
  • ist der Parameter "platform" mit "1" gesetzt, wird dadurch ein Edelprofil auf studiVZ angelegt.
  • dieses Edelprofil ist ebenfalls über meinVZ zu sehen, jedoch nicht über schülerVZ.
 Response Body:
 {
     "meta":
     {
         "version":1,
         "nonce":"",
         "count":1,
         "success":true
     },
     "content":
     {
         "guid":"le0fxLzABAIQvJV-jdAUrA"
     }
 }
  • bei erfolgreicher Anfrage wird die GUID (le0fxLzABAIQvJV-jdAUrA) des angelegten Edelprofils zurückgeliefert
  • dieses Edelprofil kann nun mittels dieser GUID und einem gültigen Authentifizierungstoken bearbeitet werden
  • es gibt zwei Möglichkeiten um ein Edelprofil zu bearbeiten

=> Edelprofilinhalt aktualisieren - update Profile

=> Edelprofil löschen - Virtual_Organisation:Delete_Profile



Schritt für Schritt | <= vorheriger Schritt 2 | Schritt 3 | nächster Schritt 4 =>