pm_GetPersonTypeMetaInfo_Ad [dstore]

Inhaltsverzeichnis

pm_GetPersonTypeMetaInfo_Ad

pm_GetPersonTypeMetaInfo_Ad

Gibt zu Personen-Typen sogenannten Meta-Informationen (wie Anzahl Personen dieses Typs etc.) aus.

HTTP-Method	GET
HTTP-Auth	Optional
Alias	pm_GetPersonTypeMetaInformation_Ad
Tags	[pm, Get, Person, Type, Meta, Information, Ad]
Engine-Kategorie	person management
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
PersonTypeID	NULL	ID eines Personen-Typs. Falls angegeben, werden nur Meta-Informationen zu diesem Personen-Typ ausgegeben.	tinyint	4.0.4
MetaInformationTypeIDList	NULL	Liste (durch „¶“ getrennt) von „MetaInformationTypeID“s. Wenn angegeben, werden nur bestimmte Meta-Informationen ermittelt - mögliche Werte (sprich „MetaInformationTypeID“s) : siehe mi_GetMetaInformationTypes_Ad TableID = 7	varchar(100)	4.0.4

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
PersonTypeID	ID eines Personen-Typs	tinyint	4.0.4
MetaInformationType	Art der Information (z.B. „Erstellungsdatum“)	varchar(50)	4.0.4
TranslatedMetaInformation	Die gespeicherte Information (zu „PersonTypeID“) zur Art „MetaInformationType“ im „Klartext“. Je nach Art der Information steht hier ein Datum im Format „Apr 15 2001 17:55:23:283PM“ oder ein „UserName“ (aus „UserInfo“)	varchar(255)	4.0.4
MetaInformationTypeID	ID der Informations-Art	tinyint	4.0.4
MetaInformation	Die gespeicherte Information (zu „PersonTypeID“) zur Art „MetaInformationType“ wie sie intern gespeichert ist (als Zahl nämlich)	decimal(19,4)	4.0.4

Sortierung der Rückgabe

(parameterunabängige Sortierung)

PersonTypeID (aufsteigend)
MetaInformationType (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-569	Der Benutzer hat kein Ausführungsrecht für die Prozedur	nur indirekt
-567	Die Prozedur darf z. Zt. nicht ausgeführt werden	nur indirekt
-566	Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werden	nur indirekt
-535	Das Datum liegt nicht in der Vergangenheit	nur indirekt
-530	Der Wert ist nicht konvertierbar	nur indirekt
-510	Der Benutzer ist nicht registriert	nur indirekt
-504	Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochen	nur indirekt
-502	Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)	nur indirekt
-500	Falsche Parameter	nur indirekt

XML-Schema

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

Historie

7.0.7	2015-01-29	Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
6.5.4	2013-04-29	Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
4.0.15	2004-07-30	1. Aufruf der Prozeduren „_mi_StartProcedure“, „_mi_FinishProcedure“ und „_mi_ChooseParamValueSeperator“ 2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur
4.0.4	2003-08-26	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:

pm_GetPersonTypeMetaInfo_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/pm_GetPersonTypeMetaInfo_Ad'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/pm_GetPersonTypeMetaInfo_Ad' | 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'),
	'pm_GetPersonTypeMetaInfo_Ad',
		array(
			// 'PersonTypeID' => NULL,
			// 'MetaInformationTypeIDList' => NULL
		)
);
 
$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="pm_GetPersonTypeMetaInfo_Ad">
			<Parameters>
				<!-- <Parameter Name="PersonTypeID">NULL</Parameter> -->
				<!-- <Parameter Name="MetaInformationTypeIDList">NULL</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