Virtual Organisation:Mittels REST API alle Kategorien holen

From VZ Developer Wiki
Jump to: navigation, search

Schritt für Schritt | <= vorheriger Schritt 6 | Schritt 7 | nächster Schritt 8 =>


Es gibt die Möglichkeit Edelprofile in Kategorien einzuordnen. Im sogenannten Edelkompass ([1], [2], [3]) wird das Edelprofil dann in den entsprechenden Kategorien angezeigt.

Dabei kann ein Edelprofil in genau eine Primär- sowie mehrere Sekundärkategorien eingeordnet werden. Dabei ist zu beachten, dass das Edelprofil nur dann sichtbar ist, wenn eine Kategorie ausgewählt wird, welche keine weiteren Unterkategorien besitzt.

Die Kategorien werden bei der Aktualisierung im JSON gesetzt. Um eine Auflistung aller verfügbaren Kategorien zu erhalten, kann die folgende Anfrage genutzt werden.

Beispiel für die Anfrage:

  • die Anfrage muss über die Methode GET abgesetzt werden.

Notwendige Parameter dafür sind:

  • platform => 1
  • token => 1272ab3c77d40ccdd248e139bddfcad42db9b52c
https://vo.apivz.net/Api/Vo/V1/?action=categories&platform=1&token=1272ab3c77d40ccdd248e139bddfcad42db9b52c


Beispiel Response:

{
    "meta":
    {
        "version":1,
        "nonce":"",
        "count":1,
        "success":true
    },
    "content":
       {
       "categories":
            [{"categoryId":"3","categoryName":"TV und Film","parentId":"1"}, 
             {"categoryId":"4","categoryName":"Kinofilme","parentId":"3"},
             {"categoryId":"5","categoryName":"Comedy und Shows","parentId":"3"},
             {"categoryId":"31","categoryName":"Sport","parentId":"1"},
             {"categoryId":"32","categoryName":"Vereine","parentId":"31"},
             {"categoryId":"34","categoryName":"SportlerInnen","parentId":"31"}
            ]
       }
}

In der Response werden alle Kategorien, welche auf der jeweiligen Platform im Edelkompass sichtbar sind, zurückgegeben.


Schritt für Schritt | <= vorheriger Schritt 6 | Schritt 7 | nächster Schritt 8 =>