Investigation.List - 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

Damit der Überblick über die ausgelösten Recherchen gewahrt wird, erhalten Sie hier die Übersicht Ihrer ausgelösten Recherchen. Diese Auflistung verfügt über das Datum der Bestellung, den Namen des gesuchten Unternehmens, Ihr persönliches Aktenzeichen sowie das bestellte Produkt. Ebenso können Sie hier den Status Ihrer jeweiligen Recherche erkennen, ob diese sich noch in der Bearbeitung befindet, ob die Recherche bereits geliefert wurde oder ob Ihre Recherche wieder storniert wurde.

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	STATUS	string	Status der Recherche (OPEN - noch offen, FINISHED - erledigt, DOWNLOADED - erledigt und bereits heruntergeladen)
REQUEST	ALL_USERS	boolean	Recherchen aller User einer Kunden-ID anzeigen?
REQUEST	ALL_CUSTOMERS	boolean	Recherchen aller Kunden (eines Partners) anzeigen? Dazu muß ALL_USERS ebenfalls gesetzt sein.
REQUEST	RETURN_MAX	int	Es werden nur die letzten ... Recherchen angezeigt (Default: 10)

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)
	LIST	array
LIST	ADR_LINE	string
LIST	CEO_NME	string
LIST	CLIENT_REF	string
LIST	COMMENT	string
LIST	CTRY_CD	string
LIST	DUNS_NBR	int
LIST	LANGUAGE	string
LIST	POST_CODE	string
LIST	POST_TOWN	string
LIST	PRIM_NME	string
LIST	PRIORITY	boolean
LIST	PRODUCT	string
LIST	STATUS	string
LIST	TICKET_ID	string
LIST	TLCM_NBR	string
LIST	TYPE	string

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.

[
  {
    'ADR_LINE' => 'Egensegardavej 4 Aps',
    'CEO_NME' => '',
    'CLIENT_REF' => '24731',
    'COMMENT' => 'Wer sind die Gesellschafter/Aktionäre?',
    'CTRY_CD' => 'DK',
    'DUNS_NBR' => '309329436',
    'LANGUAGE' => 'GE',
    'POST_CODE' => '5450',
    'POST_TOWN' => 'Otterup',
    'PRIM_NME' => 'Arrild Ejendomme ApS',
    'PRIORITY' => 0,
    'PRODUCT' => 'STANDARDBERICHT',
    'STATUS' => 'FINISHED',
    'TICKET_ID' => '97051-217325-12309',
    'TLCM_NBR' => '',
    'TYPE' => 'REPORT'
  },
  {
    'ADR_LINE' => 'Bredowstr. 34a',
    'CEO_NME' => '',
    'CLIENT_REF' => '24396',
    'COMMENT' => '',
    'CTRY_CD' => 'DE',
    'DUNS_NBR' => '344539460',
    'LANGUAGE' => 'GE',
    'POST_CODE' => '22113',
    'POST_TOWN' => 'Hamburg',
    'PRIM_NME' => 'PROCON Event Engineering GmbH',
    'PRIORITY' => 0,
    'PRODUCT' => 'STANDARDBERICHT',
    'STATUS' => 'FINISHED',
    'TICKET_ID' => '96830-217325-12309',
    'TLCM_NBR' => '',
    'TYPE' => 'REPORT'
  },
  {
    'ADR_LINE' => 'Buchenstraße 6',
    'CEO_NME' => 'Klaus Albert',
    'CLIENT_REF' => '21795',
    'COMMENT' => 'DE132364003 bisheriger Geschäftsführer: Karl Sauerteig GF seit 01.01.07: Herr Klaus Albert und Herr Kierstein',
    'CTRY_CD' => 'DE',
    'DUNS_NBR' => '328132667',
    'LANGUAGE' => 'GE',
    'POST_CODE' => '95339',
    'POST_TOWN' => 'Neuenmarkt',
    'PRIM_NME' => 'Xpoint Software GmbH',
    'PRIORITY' => 0,
    'PRODUCT' => 'STANDARDBERICHT',
    'STATUS' => 'FINISHED',
    'TICKET_ID' => '96774-217325-12309',
    'TLCM_NBR' => '09227-9450-0',
    'TYPE' => 'REPORT'
  },
  {
    'ADR_LINE' => 'Münchener Str. 101h',
    'CEO_NME' => '',
    'CLIENT_REF' => '25173',
    'COMMENT' => '',
    'CTRY_CD' => 'DE',
    'DUNS_NBR' => '342741332',
    'LANGUAGE' => 'GE',
    'POST_CODE' => '85737',
    'POST_TOWN' => 'Ismaning',
    'PRIM_NME' => 'Home Shopping Europe GmbH & Co.KG',
    'PRIORITY' => 0,
    'PRODUCT' => 'STANDARDBERICHT',
    'STATUS' => 'FINISHED',
    'TICKET_ID' => '96675-217325-12309',
    'TLCM_NBR' => '',
    'TYPE' => 'REPORT'
  },
  {
    'ADR_LINE' => 'Am Coloneum 1',
    'CEO_NME' => '',
    'CLIENT_REF' => '25173',
    'COMMENT' => '',
    'CTRY_CD' => 'DE',
    'DUNS_NBR' => '314286449',
    'LANGUAGE' => 'GE',
    'POST_CODE' => '50829',
    'POST_TOWN' => 'Köln',
    'PRIM_NME' => 'RTL Shop GmbH',
    'PRIORITY' => 0,
    'PRODUCT' => 'STANDARDBERICHT',
    'STATUS' => 'FINISHED',
    'TICKET_ID' => '96672-217325-12309',
    'TLCM_NBR' => '',
    'TYPE' => 'REPORT'
  }
];