Technische Details

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.
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 wenn nicht anders gewünscht im JSON-Format gesendet.

(Verkürztes) Beispiel für eine gültige NVP Anfrage:
https://vk.nuernberg.de/import.php?USERNAME=partnername&password=passphrase&...

Folgender String

TITEL=Hallo Welt

Muss URL-encoded übermittelt werden, was so aussehen würde:

TITEL=Hallo+Welt

Serverantwort

Eine Antwort des Servers könnte wie folgt aussehen:

JSON:

{

"import": {

"veranstaltungid": 109157,

"titel": "Ein Titel"

"abfragestart": "2020-09-28 13:14:47",

"abfragefertig": "2020-09-28 13:14:47"

}

XML:
<?xml version="1.0" encoding="UTF-8"?>
<STATUS code="0" version="1.0" docversion="1.0.5">
<ANFRAGEZEIT>2012-04-02 16:45:17</ANFRAGEZEIT>
<AUSGABEZEIT>2012-04-02 16:45:18</AUSGABEZEIT>
<VERANSTALTUNG IDINTERN="19643">WILDSTYLE</VERANSTALTUNG>
</STATUS>

Die Details für alle zwingend erforderlichen und möglichen Parameter erfahren Sie auf den folgenden Seiten.
Im code-Parameter wird ein ggfs. vorhandener Fehler-Code angegeben. Derzeit gibt es hier nur 0 für „OK“ und 1 für „Fehler“. Der version-Parameter gibt die Version der Schnittstelle an.

Im Element ANFRAGEZEIT/abfragestart steht das genaue Datum und die Uhrzeit, zu der die Anfrage einging.
Im Element AUSGABEZEIT/abfragefertig steht das genaue Datum und die Uhrzeit, zu der die Anfrage komplett abgearbeitet und ausgegeben wurde.

<VERANSTALTUNG IDINTERN="19643">WILDSTYLE_20120417</VERANSTALTUNG>

Im Attribut IDINTERN wird die für jede Veranstaltung einmalige, intern verwendete Datenbank-ID angegeben. Diese wird u.a. für das NVP „VERANSTALTUNGID“ bei Veranstaltungsupdates benötigt.
Diese ID sollten Sie lokal speichern, da sie benötigt wird, um später programmatisch Änderungen an den Daten vornehmen zu können.

Ein Fehler würde sich wie folgt äußern:

JSON:

{

"LOGIN": [

"Sie haben einen falschen Benutzername oder ein falsches Passwort eingegeben!"

]

}

XML:

<?xml version="1.0" encoding="utf-8"?>

<![CDATA[Kein Titel angegeben]]>

</FEHLER>

</STATUS>