Das API versteht sowohl GET als auch POST Anfragen. GET Anfragen müssen URL-encoded sein. Als Charset wird UTF-8 verwendet.
Der Name darf sowohl in Groß- wie auch Kleinschreibung angegeben werden (case-insensitive). Der Übersichtlichkeit halber sollten die Namen aber in Großschreibung angegeben werden.
Nummerierungen in Parametern beginnen immer mit 1 und müssen fortlaufend sein. Wenn also ein Parameter mit z.B. PARAMETER1...n angegeben ist, dann heißt das, dass z.B. folgende Übergabe möglich ist: PARAMETER1=27&PARAMETER2=15&PARAMETER3=9
Folgendes ist nicht erlaubt (überspringen von Nummern): PARAMETER1=27&PARAMETER4=15&PARAMETER6=9
Ja / Nein Parameter, d.h. True / False werden mit 1 bzw. 0 codiert.
Die Reihenfolge der NVP-Parameter spielt keine Rolle.
Die Antwort des API wird im JSON- oder XML-Format gesendet.
(Verkürztes) Beispiel für eine gültige NVP Anfrage:
https://vk.nuernberg.de/export.php?USERNAME=partnername&password=passphrase&...
Folgender String
SUCHTEXT=Bildende Kunst
muss URL-encoded übermittelt werden, was so aussehen würde:
SUCHTEXT=Bildende+Kunst
Eine Antwort des Servers könnte wie folgt aussehen:
<?xml version="1.0" encoding="UTF-8"?>
<ERGEBNIS STATUS="0" version="2.0">
<VERANSTALTUNG ID="17454" GLOBALEID="WILDSTYLE_2012-06-12">
<TITEL>WILDSTYLE</TITEL>
<KURZBESCHREIBUNG>Eine wilde Party im Hirsch</KURZBESCHREIBUNG>
<OEFFNUNGSZEITEN>
<DATUM BEGINN="22:00" ENDE="05:00" EINLASS="">2012-06-12</DATUM>
<OEFFNUNGSZEITEN>
</VERANSTALTUNG>
<ANFRAGEZEIT>2012-04-02 16:45:17</ANFRAGEZEIT>
<AUSGABEZEIT>2012-04-02 16:45:18</AUSGABEZEIT>
</ERGEBNIS>
Einzelne TAGS und PRIVATETAGS werden im Ergebnis mittels || getrennt ausgegeben.