Liefert den hinterlegten Wert aus „PersonTypeSettings“ zu einem bestimmten Personen-Typ und einem bestimmten Schlüssel.
HTTP-Method | GET |
HTTP-Auth | Optional |
Tags | |
Engine-Kategorie | person management |
Engine-Typ | Daten-Ermittlung |
Letzte Aktualisierung | 6.5.1 (2012-11-02) |
Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
---|---|---|---|---|
PersonTypeID | ID eines Personen-Typs | tinyint | 4.0.5 | |
KeyVariable | Ein Schlüssel (z.B. „PersonIdentificationIDs“), zu dem der hinterlegte Wert zum Personen-Typ „PersonTypeID“ ausgegeben werden soll. Mögliche Werte : siehe Rückgabemenge von „ do_GetSettingsDescriptions_Ad 'PersonTypeSettings' “. | varchar(50) | 4.0.5 | |
SelectResult | 0 | „0“ : Der zum Schlüsel „KeyVariable“ hinterlegte Wert wird NUR über den Ausgabeparameter „Value“ zurückgegeben „1“ : Es wird ZUSÄTZLICH eine Rückgabemenge bereitgestellt | bit | 4.0.5 |
PrintErrorMsgIfEntryIsMissing | 0 | Falls KEIN Eintrag gefunden wird, gibt es immer einen Fehler. Gibt man hier „1“ an, wird in so einem Fall eine entsprechende Meldung via „print“ erzeugt (was die Fehler-Analyse erleichtert, wenn diese Prozedur innerhalb anderer aufgerufen wird). | bit | 6.0.3 |
TryGlobalSettingForMissingKey | 0 | Wird nur beachtet, wenn „PersonTypeID“ NICHT „0“ ist ! Falls kein Eintrag für „PersonTypeID“ gefunden wird UND man hier „1“ angibt, wird nach einem Eintrag zur „PersonTypeID = 0“ gesucht (und sofern vorhanden zurückgegeben). | bit | 6.5.1 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
Value | Der für den Personen-Typ „PersonTypeID“ zum Schlüssel „KeyVariable“ hinterlegte Wert | varchar(100) | 4.0.5 |
Value | Ausgabeparameter für den zum Schlüssel „KeyVariable“ (für den Personen-Typ „PersonTypeID“) hinterlegten Wert |
Code | Beschreibung | Quelle 5) |
---|---|---|
-621 | Fehlender oder falscher Eintrag in PersonTypeSettings | nur direkt |
Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.
6.5.1 | 2012-11-02 | Neuer Parameter „TryGlobalSettingForMissingKey“ |
6.0.3 | 2011-09-07 | 1. Quellcode-Anpassung an den aktuellen Standard 2. Neuer Parameter „PrintErrorMsgIfEntryIsMissing“ |
4.0.5 | 2003-10-04 | Erstmalig in dieser Version erstellt |
Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:
Unformatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/pm_GetPersonTypeSettingEntry?PersonTypeID=<value>&KeyVariable=<value>'
Mit xmllint 6) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/pm_GetPersonTypeSettingEntry?PersonTypeID=<value>&KeyVariable=<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_GetPersonTypeSettingEntry', array( 'PersonTypeID' => <value>, 'KeyVariable' => '<value>', // 'SelectResult' => 0, // 'PrintErrorMsgIfEntryIsMissing' => 0, // 'TryGlobalSettingForMissingKey' => 0 ) ); $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_GetPersonTypeSettingEntry"> <Parameters> <Parameter Name="PersonTypeID"><!-- tinyint value --></Parameter> <Parameter Name="KeyVariable"><!-- varchar value --></Parameter> <!-- <Parameter Name="SelectResult">0</Parameter> --> <!-- <Parameter Name="PrintErrorMsgIfEntryIsMissing">0</Parameter> --> <!-- <Parameter Name="TryGlobalSettingForMissingKey">0</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>