mi_GetVisitorInformation_Pu [dstore]

Inhaltsverzeichnis

mi_GetVisitorInformation_Pu

mi_GetVisitorInformation_Pu

Gibt Informationen, die zu einem Besucher gespeichert wurden, zurück.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[mi, Get, Visitor, Information, Pu]
Engine-Kategorie	miscellaneous
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.4 (2014-03-19)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
UniqueID		Eindeutige ID eines Besuchers (aus „Visitors“)	varchar(50)	3.5.11
InformationTypeID	NULL	ID eines Informationstyps (für Besucher - z.B. die IP-Adresse). Wenn angegeben, wird nur die Information zu diesem Informationstyp (für den Besucher „UniqueID“) ermittelt.	tinyint	3.5.11
StartAtRowNo	1	Legt fest, ab welchem Datensatz die Ausgabe gestartet werden soll. Mit Hilfe dieses Parameters und „NumberOfRows“ kann man sich quasi durch alle Datensätze „blättern“.	integer	3.5.11
NumberOfRows	10	Beschränkt die Anzahl Datensätze, die zurückgegeben werden (maximal 255). Mit Hilfe dieses Parameters und „StartAtRowNo“ kann man sich quasi durch alle Datensätze „blättern“.	tinyint	3.5.11
SortDesc	1	Legt fest, ob in der Rückgabemenge nach „InfoDateAndTime“ auf- oder absteigend sortiert werden soll: „0“ : Aufsteigende Sortierung „1“ : Absteigende Sortierung	bit	3.5.11
SortByInformationTypeID	0	Wie soll die Rückgabemenge sortiert werden ? „0“ : Sortierung nach „InfoDateAndTime“ (auf- oder absteigend, je nach „SortDesc“) „1“ : Sortierung nach „InformationTypeID“ (aufsteigend) und „InfoDateAndTime“ (auf- oder absteigend, je nach „SortDesc“)	bit	3.5.11

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
VisitorID	ID des zur „UniqueID“ korrespondierenden Besuchers	integer	3.5.11
InformationTypeID	ID eines Informationstyps	tinyint	3.5.11
InformationType	Bezeichnung des Informationstyps „InformationTypeID“ (z.B. „IP-Adresse“)	varchar(50)	3.5.11
Information	Die hinterlegte Information	varchar(50)	3.5.11
InfoDateAndTime	Wann wurde die Information gespeichert ?	datetime	3.5.11
InfoDateAndTime_char	Enthält „InfoDateAndTime“ als „String“ - im Format „15.03.2001 08:26:13“	varchar(19)	3.5.11

Sortierungen der Rückgabe

wenn SortDesc = 0 und SortByInformationTypeID = 0

InfoDateAndTime (aufsteigend)

wenn SortDesc = 1 und SortByInformationTypeID = 0

InfoDateAndTime (absteigend)

wenn SortDesc = 0 und SortByInformationTypeID = 1

InformationTypeID (aufsteigend)
InfoDateAndTime (aufsteigend)

wenn SortDesc = 1 und SortByInformationTypeID = 1

InformationTypeID (aufsteigend)
InfoDateAndTime (absteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-600	Es konnte keine gültige VisitorID ermittelt werden	nur direkt
-500	Falsche Parameter	nur direkt

XML-Schema

Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.

Historie

7.0.4	2014-03-19	Quellcode-Anpassungen an den aktuellen Standard
3.5.11	2001-09-06	Erstmalig in dieser Version erstellt

Code-Snippets

Engine Playground

Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:

mi_GetVisitorInformation_Pu im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/mi_GetVisitorInformation_Pu?UniqueID=<value>'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/mi_GetVisitorInformation_Pu?UniqueID=<value>' | xmllint --format -

dStore_php

use dStore_php\WebService;
 
$service = new WebService\Service( WebService\Scheme::HTTP,'<partner>-<project>.dstore.de', 80);
 
$request = new WebService\Requests\Engine\Procedure\Request(
			new WebService\Requests\AccessData('default'),
	'mi_GetVisitorInformation_Pu',
		array(
			'UniqueID' => '<value>',
			// 'InformationTypeID' => NULL,
			// 'StartAtRowNo' => 1,
			// 'NumberOfRows' => 10,
			// 'SortDesc' => 1,
			// 'SortByInformationTypeID' => 0
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();

engine/execute

XML zur Ausführung mit der Methode engine/execute, z.B. per

curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>'

<?xml version="1.0" encoding="UTF-8"?>
<ListOfBatches>
	<Batch No="0">
		<Procedure Name="mi_GetVisitorInformation_Pu">
			<Parameters>
				<Parameter Name="UniqueID"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="InformationTypeID">NULL</Parameter> -->
				<!-- <Parameter Name="StartAtRowNo">1</Parameter> -->
				<!-- <Parameter Name="NumberOfRows">10</Parameter> -->
				<!-- <Parameter Name="SortDesc">1</Parameter> -->
				<!-- <Parameter Name="SortByInformationTypeID">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾

direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“

⁶⁾

I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Inhaltsverzeichnis