Virtual Organisation:Update Profile

From VZ Developer Wiki
Jump to: navigation, search

Inhaltsverzeichnis, API-Methoden, Schritt für Schritt


Update profile

  • Zusammenfassung: Existierendes Profil aktualisieren
    • Es müssen nur die Parameter angegeben werden, die geändert werden sollen.
  • Plattform-IDs: (1=studiVZ/meinVZ, 2=schuelerVZ)
  • HTTP Methode: PUT
  • Header: content-type: application/json
  • Request message:
  {
      "general":
      {
        "firstName" : "Maxi",
        "lastName" : "Mustermännchen",
        "email" : "new@email.de",
        "birthday":"2010-08-05"
      },
      "settings":
      {
        "invisible":"0",
        "showFlipside":"1",
        "deactivateFrontside":"0",
        "activateFlipsideMenu":"1"
      },
      "category":
      {
        "primaryCategory" : "3",
        "secondaryCategories" : ["212", "242", "536", "541"]
      },
      "content": 
      {
        "frontsideContent" : "<p>newText new Text newText newText newText</p>",
        "flipsideContent" : "<p>newText newText newText newText newText</p>"
      },
      "images":
      {
        "profileImages":
        {
          "small":"<base64 encoded string>",
          "medium":"<base64 encoded string>",
          "big":"<base64 encoded string>" 
        }
      }
  }


  • Response: Statusmeldung
   {
       "meta":
       {
           "version":1, 
           "nonce":"", 
           "count":1, 
           "success":true
       }, 
       "content":"profile {guid} successfully updated"
   }

Aufbau des Json Request-Body

Image Handling

Um ein Bild für das Profil anzugeben, muss im Request ein base64 verschlüsselter String übergeben werden. Es werden automatisch alle dazugehörigen Profilbildergrößen generiert, wenn keine weiteren (keys: big, medium, small) angegeben sind.

{
      "images":
      {
        "profileImages":
        {
          "big":"<base64 encoded string>" 
        }
      }
}

Es gibt auch die Möglichkeit, alle 3 Profilbilder selbst zu definieren:

  • die Auflösung für "small" ist: 50px mal 50px
  • die Auflösung für "medium" ist: 100px mal 100px
  • die Auflösung für "big" ist: 200px mal 300px
{
      "images":
      {
        "profileImages":
        {
          "small":"<base64 encoded string>",
          "medium":"<base64 encoded string>",
          "big":"<base64 encoded string>" 
        }
      }
}

Um alle Profilbilder eines Profiles zu löschen, müssen die Bilder des Objektes zurückgesetzt werden:

{
      "images":
      {
        "profileImages":
        {
          "small":"",
          "medium":"",
          "big":"" 
        }
      }
}

Inhaltsverzeichnis, API-Methoden, Schritt für Schritt