Monitoring.New - Web-Dokumentation
Sollten nicht alle Ihre Fragen auf dieser Webseite beantwortet werden, so wenden Sie sich bitte an unsere IT-Abteilung unter der kostenlosen Hotline: 0800 / 11 44 111.
Inhaltsverzeichnis
- Allgemeine Funktionsbeschreibung
- Request - Anfrage an den XML-Server
- Response - Antwort vom XML-Server
- Beispiel-Antwort des XML-Servers
1. Allgemeine Funktionsbeschreibung
Neben dem Abruf von Auskünften, speziell dem Global Business Check und dem Global Business Check plus, können zu diesen Produkten auch das Monitoring bestellt werden. Hierbei haben Sie zwei Möglichkeiten, entweder Sie integrieren Monitoring.New direkt in die Auskunftselemente Ihres Global Business Check bzw. in des Global Business Check plus, so dass direkt aus der Auskunftsanzeiger heraus das Monitoring bestellt werden kann. Oder Sie setzten Monitoring.New als Einzelprodukt. Natürlich besteht auch die Möglichkeit beide Varianten zu nutzen, da dies den Vorteil bringt, dass Sie oder der Kunde entscheiden können wann und wie das Monitoring bestellt werden soll.
2. Request - Anfrage an den XML-Server
| struct/array | Feldname | Datentyp | Beschreibung |
|---|---|---|---|
| SIGNON | struct | allgemeine Angaben (zur Identifizierung des Anfragenden) | |
| SIGNON | USER_ID | int | User-ID von handelsauskunft.com (z. B. 210234) |
| SIGNON | PASSWORD | string | Passwort zur User-ID (Änderung im Kundenbereich der Webseite möglich) |
| SIGNON | SESSION_ID | string | Kann alternativ zu USER_ID und PASSWORD angegeben werden, wird von [Session.Login][] vergeben |
| SIGNON | CUSTOMER_DUNS | int | D-U-N-S Nr. des Kunden, für den die Auskunft abgerufen wird (siehe Vertrag) |
| REQUEST | struct | Anfrage-spezifische Angaben (die ersten 3 Felder sind allerdings bei allen Anfragen enthalten) | |
| REQUEST | CLIENT_REF | string | Aktenzeichen (beliebiger Inhalt), wird unverändert wieder zurückgegeben |
| REQUEST | VERSION | string | Version der XML-Schnittstelle, muß derzeit "0.1" sein |
| REQUEST | REASON | string | [Anfragegrund][] |
| REQUEST | TEST | boolean | Kostenlose Testdaten werden bei "TEST = 1" zurück geliefert. Bei "TEST = 0" oder wenn "TEST" fehlt, dann werden immer Echt-Daten abgerufen! |
| REQUEST | DUNS_NBR | int | D-U-N-S Nr. |
| REQUEST | CTRY_CD | string | [Länderkode][] (2 Zeichen) |
| REQUEST | PRIM_GEO_AREA | string | [Bundesstaat][] (nur bei USA und Kanada erforderlich) |
| REQUEST | PRODUCT | string | Produkt: (derzeit nur: "DnB.QuickCheck") |
3. Response - Antwort vom XML-Server
| struct/array | Feldname | Datentyp | Beschreibung |
|---|---|---|---|
| RESPONSE | struct | allgemeine Angaben (Aktenzeichen und Preis) | |
| RESPONSE | CLIENT_REF | string | Wiederholung des Aktenzeichen |
| RESPONSE | SERVER_REF | string | Aktenzeichen auf Serverseite (bitte bei Rückfragen angeben) |
| RESPONSE | PRICE_UNITS | double | Preis der Auskunft in Einheiten |
| RESPONSE | PRICE_EURO | double | Preis der Auskunft in Euro (Netto-Betrag) |
| NEW | struct | ||
| NEW | MONITORING_ID | int | Monitoring-ID des neuen Auftrags |
4. Beispiel-Antwort des XML-Servers
Anfolgendes Beispiel erhalten Sie, wenn Sie bei der Anfage an den XML-Server das Parameter: TEST = 1 setzen. Die Nachfolgende Ausgabe wurde mit dem Modul: Dumper erzeugt und zeigt die Struktur der Antwort auf.
{
'MONITORING_ID' => '98765'
};