Prozedur zur Suche nach Personen, die bestimmte Eigenschaften besitzen.

Anmerkung zum Parameter „CharacteristicIDList“ :

Für alle angegebenen Merkmale muß der Aufrufer vollständigen lesenden Zugriff besitzen (s. pm_GetPChAccRestrForUsers_Ad), ansonsten gibt es einen Fehler !

Anmerkungen zum Parameter „ConditionList“ :

1. Es können Werte und Wertbereiche angegeben werden. Jede einzelne Bedingung muß eines der folgenden Formate haben (dabei ist unbedingt die Reihenfolge zu beachten !) :

• {} oder {) oder {] oder (} oder () oder (] oder [} oder [) oder [] → Es sollen alle Personen gesucht werden, die das entsprechende Merkmal NICHT haben.
• (Wert1|Wert2) → „>=“ Wert1 und „⇐“ Wert2
• (Wert1|Wert2] → „>=“ Wert1 und „<“ Wert2
• [Wert1|Wert2) → „>“ Wert1 und „⇐“ Wert2
• [Wert1|Wert2] → „>“ Wert1 und „<“ Wert
• {Wert → „<>“ Wert
• (Wert → „>=“ Wert
• [Wert → „>“ Wert
• ~Wert → „Like“ Wert, aber case-INsensitiv
• ^Wert → „= soundex(Wert)“
• Wert) → „⇐“ Wert
• Wert] → „<“ Wert
• Wert → „Like“ Wert

Hinweis : „Wert“ oder „Wert1“ oder „Wert2“ meint einen „string“, der NICHT „NULL“ ist !

2. Sofern eine Bedingung eines der Formate „Wert“ oder „~Wert“ hat (also eine „LIKE“-Suche durchgeführt werden soll), können sogenannte Platzhalter verwendet werden :

• '_' oder '?' : Platzhalter für EIN Zeichen
• '%' oder '*' : Platzhalter für eine ZeichenKETTE

3. Um nach einem Wert zu suchen, der mit „[“ oder „(“ oder „{“ oder „~“ oder „^“ beginnt oder der mit „]“ oder „)“ oder „}“ endet, muß man den „~“-Operator verwenden (z.B. „~[*“ angeben, um nach Werten zu suchen, die mit „[“ beginnen)

4. Soll in einer „LIKE“-Suche (d.h. wenn die Bedingung das Format „Wert“ oder „~Wert“ hat) nach einem Platzhalter-Zeichen selbst gesucht werden, ist dieses Zeichen 2mal hintereinander einzugeben (z.B. würde durch Angabe von „%%%“ nach Werten gesucht werden, die mit „%“ beginnen)

5. Im Falle einer „LIKE“-Suche (d.h. wenn die Bedingung das Format „Wert“ oder „~Wert“ hat) werden (in dieser Reihenfolge !) folgende Ersetzungen vorgenommen :

• „?“ durch „_“, ausgenommen „??“ (diese Zeichenkette wird durch „?“ ersetzt)
• „*“ durch „%“, ausgenommen „**“ (diese Zeichenkette wird durch „*“ ersetzt)
• „__“ durch „[_] (um nach dem Zeichen „_“ selbst suchen zu können, siehe 4.)
• “%%„ durch “[%] (um nach dem Zeichen „%“ selbst suchen zu können, siehe 4.)

⇒ Daher wird z.B. „?_“ sowie „_?“ durch „[_]“ ersetzt, oder „*%“ sowie „%*“ durch „[%]“. Allerdings wird z.B. „__?“ durch „[_]_“ ersetzt !

6 . Falls eine Bedingung ein Datums-/Uhrzeitformat hat, muß angegeben sein, um welches Länderformat es sich dabei handelt (siehe Parameter „Country“)

Anmerkungen zum Parameter „OutputCharacteristicIDs“ :

1. Bei den hier angegebenen Merkmalen muß es sich immer um Pflicht-Merkmale („Required = 1“, siehe pm_GetPersonCharacteristics_Ad) handeln !
2. Für alle angegebenen Merkmale muß der Aufrufer vollständigen lesenden Zugriff besitzen (s. pm_GetPChAccRestrForUsers_Ad), ansonsten gibt es einen Fehler !

Anmerkung zu den Parametern „LastValues“ und „LastPersonID“ :

Die durch „LastValues“ angegebenen Werte müssen natürlich zu den in „OutputCharacteristicIDs“ angegebenen Ausgabemerkmalen korrespondieren ! Sind keine Ausgabemerkmale angegeben, werden die „PersonID“s ermittelt, die größer bzw. kleiner (je nach „Next“) als „LastPersonID“ sind. Letzter Parameter wird auch benötigt, wenn es MEHRERE Personen gibt, die die in „LastValues“ angegebenen Eigenschaften haben.

Anmerkung zum Parameter „RowNumber“ :

Möchte man alle Datensätze der Suche zurückbekommen, ist „RowNumber = NULL“ zu übergeben.

Anmerkung zur Sortierung (falls Eigenschaften ausgegeben werden) :

Obwohl alle Eigenschaften als „strings“ gespeichert sind, wird bei der Sortierung auf das zum Merkmal hinterlegte Format geachtet, d.h. handelt es sich bei den Eigenschaften z.B. um Datumsangaben, wird die Datums-Sortierung (und nicht die alphanumerische Sortierung) verwendet.

(parameterunabängige Sortierung)

• PersonID (aufsteigend)

wenn SortOrder1 = 1

• Value1 (aufsteigend)
• PersonID (aufsteigend)

wenn SortOrder1 = 0

• Value1 (absteigend)
• PersonID (aufsteigend)

wenn SortOrder1 = 1 und SortOrder2 = 1

• Value1 (aufsteigend)
• Value2 (aufsteigend)
• PersonID (aufsteigend)

wenn SortOrder1 = 0 und SortOrder2 = 1

• Value1 (absteigend)
• Value2 (aufsteigend)
• PersonID (aufsteigend)

wenn SortOrder1 = 0 und SortOrder2 = 0

• Value1 (absteigend)
• Value2 (absteigend)
• PersonID (aufsteigend)

wenn SortOrder1 = 1 und SortOrder2 = 0

• Value1 (aufsteigend)
• Value2 (absteigend)
• PersonID (aufsteigend)

wenn SortOrder1 = 1 und SortOrder2 = 1 und SortOrder3 = 1

• Value1 (aufsteigend)
• Value2 (aufsteigend)
• Value3 (aufsteigend)
• PersonID (aufsteigend)

wenn SortOrder1 = 0 und SortOrder2 = 1 und SortOrder3 = 1

• Value1 (absteigend)
• Value2 (aufsteigend)
• Value3 (aufsteigend)
• PersonID (aufsteigend)

wenn SortOrder1 = 0 und SortOrder2 = 0 und SortOrder3 = 1

• Value1 (absteigend)
• Value2 (absteigend)
• Value3 (aufsteigend)
• PersonID (aufsteigend)

wenn SortOrder1 = 0 und SortOrder2 = 1 und SortOrder3 = 0

• Value1 (absteigend)
• Value2 (aufsteigend)
• Value3 (absteigend)
• PersonID (aufsteigend)

wenn SortOrder1 = 0 und SortOrder2 = 0 und SortOrder3 = 0

• Value1 (absteigend)
• Value2 (absteigend)
• Value3 (absteigend)
• PersonID (aufsteigend)

wenn SortOrder1 = 1 und SortOrder2 = 0 und SortOrder3 = 1

• Value1 (aufsteigend)
• Value2 (absteigend)
• Value3 (aufsteigend)
• PersonID (aufsteigend)

wenn SortOrder1 = 1 und SortOrder2 = 1 und SortOrder3 = 0

• Value1 (aufsteigend)
• Value2 (aufsteigend)
• Value3 (absteigend)
• PersonID (aufsteigend)

wenn SortOrder1 = 1 und SortOrder2 = 0 und SortOrder3 = 0

• Value1 (aufsteigend)
• Value2 (absteigend)
• Value3 (absteigend)
• PersonID (aufsteigend)

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

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

• pm_GetPersons_Conditions_Ad im Engine Playground öffnen

Unformatierte Ausgabe:

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

Mit xmllint ⁶⁾ formatierte Ausgabe:

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

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'),
	'pm_GetPersons_Conditions_Ad',
		array(
			'OutputCharacteristicIDs' => '<value>',
			// 'PersonTypeID' => 1,
			// 'LastValues' => NULL,
			// 'LastPersonID' => 0,
			// 'Next' => 1,
			// 'RowNumber' => 50,
			// 'GroupID' => NULL,
			// 'CharacteristicIDList' => NULL,
			// 'ConditionList' => NULL,
			// 'Country' => 'Germany',
			// 'OutputIntoOneID' => 0,
			// 'SeparatorInLastValues' => '¶',
			// 'SeparatorInConditionList' => '¶'
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();
 
$OutputParams = $xml_result->getOutputParametersAsArray();

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="pm_GetPersons_Conditions_Ad">
			<Parameters>
				<Parameter Name="OutputCharacteristicIDs"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="PersonTypeID">1</Parameter> -->
				<!-- <Parameter Name="LastValues">NULL</Parameter> -->
				<!-- <Parameter Name="LastPersonID">0</Parameter> -->
				<!-- <Parameter Name="Next">1</Parameter> -->
				<!-- <Parameter Name="RowNumber">50</Parameter> -->
				<!-- <Parameter Name="GroupID">NULL</Parameter> -->
				<!-- <Parameter Name="CharacteristicIDList">NULL</Parameter> -->
				<!-- <Parameter Name="ConditionList">NULL</Parameter> -->
				<!-- <Parameter Name="Country">'Germany'</Parameter> -->
				<!-- <Parameter Name="OutputIntoOneID">0</Parameter> -->
				<!-- <Parameter Name="SeparatorInLastValues">'¶'</Parameter> -->
				<!-- <Parameter Name="SeparatorInConditionList">'¶'</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>