co_InsertCommunityMembers_Pu [dstore]

Inhaltsverzeichnis

co_InsertCommunityMembers_Pu

co_InsertCommunityMembers_Pu

Möchte eine Person Mitglied in einer oder mehreren Community/Communities werden oder möchte ein Community-Mitglied anderen Communities beitreten, ist diese Prozedur hier zu verwenden.

Die IDs der Community/Communities, denen die Person/das Mitglied beitreten möchte, sind via „tempdb.dbo.OneID“ anzugeben.

HTTP-Method	POST
HTTP-Auth	Optional
Tags	[co, Insert, Community, Members, Pu]
Engine-Kategorie	communities
Engine-Typ	Daten-Änderung
Letzte Aktualisierung	6.5.4 (2013-04-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
UniqueID		Eindeutige ID eines Besuchers, die der zu identifizierenden Person aktuell zugeordnet ist. Falls die Identifizierungsdaten zur Person in „SessionManagement“ (zu dieser „UniqueID“) gespeichert sind, darf „PersonIdentificationValues“ auch „NULL“ sein.	varchar(50)	3.5.7
PersonIdentificationValues	NULL	Liste von Eigenschaften, die die Person identifizieren, und zwar zu den in „PersonTypeSettings“ konfigurierten Merkmal-IDs (Schlüssel „PersonIdentificationIDs“) sein - zur „PersonTypeID“ bzw. zur „PersonTypeID“ der „CommunityID“.	varchar(255)	3.5.7
CommunityID		Wird nur beachtet, wenn „PersonTypeID“ nicht angegeben ist. ID einer Community, durch die der Personentyp bestimmt wird, um die Identifiziertung durchführen zu können - die identifizierte Person muß außerdem hier Mitglied und angemeldet sein !	smallint	3.5.7
PersonTypeID	NULL	ID des Personen-Typs der zu identifizierenden Person, die Mitglied in den in „tempdb.dbo.OneID“ angegebenen Communities werden möchte. Alternativ kann „CommunityID“ angegeben werden, wenn die Person dort angemeldet ist.	tinyint	5.0.4
SeparatorInIdentVals	'¶'	Gibt an, durch welche Zeichenkette die Werte in „PersonIdentificationValues“ getrennt sind	varchar(4)	5.5.0

Rückgabe

Die Prozedur hat keine Rückgaben.

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁴⁾
-781	Fehlender oder falscher Eintrag in CommunitySettings	nur indirekt
-780	Fehlender oder falscher Eintrag in CommunityMemberSettings	nur indirekt
-774	Login vorübergehend gesperrt	nur indirekt
-773	Login gesperrt	nur indirekt
-772	User ist nicht angemeldet	nur indirekt
-771	Der Sweeper ist nicht gestartet	nur indirekt
-770	Login zur Zeit nicht möglich	nur indirekt
-660	Identifikation fehlgeschlagen	nur indirekt
-621	Fehlender oder falscher Eintrag in PersonTypeSettings	nur indirekt
-602	Zur defaultUniqueID („VisitorID = -2“) können keinerlei Daten gespeichert oder verändert werden	nur indirekt
-599	Lizenz ist ungültig oder abgelaufen	nur indirekt
-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
-550	Fehlender oder falscher Eintrag in Settings	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	direkt und indirekt

XML-Schema

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

Historie

6.5.4	2013-04-29	Datentyp des Parameters „SeparatorInIdentVals“ wg. UTF-8 Unterstützung auf „varchar[4]“ erweitert
5.5.0	2008-01-07	1. Neuer Parameter „SeparatorInIdentVals“ 2. Ausgabe an die Standard-Ausgabe [via „print“] im Fehler-Fall „-500“, die nähere Informationen über die Ursache enthält 3. Bearbeitung des Quellcodes hinsichtlich neuer Konventionen
5.0.4	2005-09-26	1. Neuer Parameter „PersonTypeID“ 2. Konsequente Fehlerbehandlung 3. Fehler bei der Einordnung in „CommunityMembers“
3.5.15	2002-03-12
3.5.7	2001-05-04	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:

co_InsertCommunityMembers_Pu im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/co_InsertCommunityMembers_Pu?UniqueID=<value>&CommunityID=<value>'

Mit xmllint ⁵⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/co_InsertCommunityMembers_Pu?UniqueID=<value>&CommunityID=<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'),
	'co_InsertCommunityMembers_Pu',
		array(
			'UniqueID' => '<value>',
			'CommunityID' => <value>,
			// 'PersonIdentificationValues' => NULL,
			// 'PersonTypeID' => NULL,
			// 'SeparatorInIdentVals' => '¶'
		)
);
 
$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="co_InsertCommunityMembers_Pu">
			<Parameters>
				<Parameter Name="UniqueID"><!-- varchar value --></Parameter>
				<Parameter Name="CommunityID"><!-- smallint value --></Parameter>
				<!-- <Parameter Name="PersonIdentificationValues">NULL</Parameter> -->
				<!-- <Parameter Name="PersonTypeID">NULL</Parameter> -->
				<!-- <Parameter Name="SeparatorInIdentVals">'¶'</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