Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:co_getonlinestatus_pu

co_GetOnlineStatus_Pu

Führt die Identifizierung einer Person durch (wie pm_CheckPersonIdentity_Pu) und stellt gleichzeitig fest, ob diese Person in einer angegebenen Community (→ „CommunityID“) gerade angemeldet (also „online“) ist, oder nicht.

Sofern das identifizierte Community-Mitglied angemeldet ist und ein Status (→ „Status“) übergeben wurde, wird eine entsprechende Aktualisierung in „CurrentlyUsersOnline“ durchgeführt.

HTTP-MethodGET
HTTP-AuthOptional
Tags
Engine-Kategoriecommunities
Engine-TypDaten-Ermittlung
Letzte Aktualisierung6.5.2 (2013-02-26)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
CommunityID ID einer Community
smallint3.5.2
UniqueID Eindeutige ID eines Besuchers, die dem zu identifizierenden Mitglied aktuell zugeordnet ist. Falls die Identifizierungsdaten zur Person in „SessionManagement“ (zu dieser „UniqueID“) gespeichert sind, darf „PersonIdentificationValues“ auch „NULL“ sein.
varchar(50)3.5.2
PersonIdentificationValues Liste von Werten, die das Mitglied identifizieren. Diese Werte müssen Eigenschaften zu den Merkmal-IDs sein, die in „PersonTypeSettings“ zur „PersonTypeID“ der „CommunityID“ zum Schlüssel „PersonIdentificationIDs“ hinterlegt sind.
varchar(255)3.5.2
Status1 „NULL“ : Keine Aktualisierung des Online-Status durchführen
„0“ oder „255“ : Nicht erlaubt, denn diese sind für „gerade eingelogged“ bzw. „offline“ reserviert
„1“ bis „254“ : Online-Status des identifizierten Mitglieds auf diesen Wert setzen
tinyint3.5.2
NoResult0 Wenn man KEINE Ergebnismenge, sondern nur die Person identifizieren möchte (und sichergestellt sein soll, daß das Mitglied auch online ist), setzt man diesen Parameter auf „1“ - und holt sich die ID dann aus dem Ausgabeparameter „CommunityMemberID“.
bit3.5.2
SeparatorInIdentVals'¶' Gibt an, durch welche Zeichenkette die Werte in „PersonIdentificationValues“ getrennt sind
varchar(4)5.5.0

Rückgabe

wenn NoResult = 0

Spaltenname Beschreibung SQL-Datentyp4) ab Version
OnlineStatusEnthält entweder einen Fehler-Code (wie „-772“ für „User ist nicht angemeldet“) oder aber den „Status“ (ein Wert zwischen „0“ und „254“) des identifizierten Mitglieds „CommunityMemberID“ aus „CurrentlyUsersOnline“
integer3.5.2
CommunityMemberIDID des identifizierten Mitglieds der Community „CommunityID“
integer3.5.2

Output-Parameter

CommunityMemberIDAusgabeparameter für die ID des identifizierten Mitglieds

Mögliche Return-Codes

Code Beschreibung Quelle 5)
-781Fehlender oder falscher Eintrag in CommunitySettingsnur indirekt
-780Fehlender oder falscher Eintrag in CommunityMemberSettingsnur indirekt
-774Login vorübergehend gesperrtnur indirekt
-773Login gesperrtnur indirekt
-772User ist nicht angemeldetdirekt und indirekt
-771Der Sweeper ist nicht gestartetnur indirekt
-770Login zur Zeit nicht möglichnur indirekt
-660Identifikation fehlgeschlagennur indirekt
-621Fehlender oder falscher Eintrag in PersonTypeSettingsnur indirekt
-602Zur defaultUniqueID („VisitorID = -2“) können keinerlei Daten gespeichert oder verändert werdennur indirekt
-599Lizenz ist ungültig oder abgelaufennur indirekt
-569Der Benutzer hat kein Ausführungsrecht für die Prozedurnur indirekt
-567Die Prozedur darf z. Zt. nicht ausgeführt werdennur indirekt
-566Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werdennur indirekt
-550Fehlender oder falscher Eintrag in Settingsnur indirekt
-535Das Datum liegt nicht in der Vergangenheitnur indirekt
-530Der Wert ist nicht konvertierbarnur indirekt
-510Der Benutzer ist nicht registriertnur indirekt
-504Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochennur indirekt
-502Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)nur indirekt
-500Falsche Parameterdirekt und indirekt

XML-Schema

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

Historie

6.5.2 2013-02-26Länge des Parameter „SeparatorInIdentVals“ wurde erweitert [von „1“ auf „4“]
5.5.0 2008-01-071. Neuer Parameter „SeparatorInIdentVals“
2. Ausgabe via „print“ im Fehler-Fall „-500“, die nähere Informationen über die Ursache enthält
3. Bearbeitung des Quellcodes hinsichtlich neuer Konventionen
4. Überarbeitung der Doku
3.5.2 2001-01-28Erstmalig 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:

cURL

Unformatierte Ausgabe:

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

Mit xmllint 6) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/co_GetOnlineStatus_Pu?CommunityID=<value>&UniqueID=<value>&PersonIdentificationValues=<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_GetOnlineStatus_Pu',
		array(
			'CommunityID' => <value>,
			'UniqueID' => '<value>',
			'PersonIdentificationValues' => '<value>',
			// 'Status' => 1,
			// 'NoResult' => 0,
			// 'SeparatorInIdentVals' => '¶'
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();
 
$OutputParams = $xml_result->getOutputParametersAsArray();
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_GetOnlineStatus_Pu">
			<Parameters>
				<Parameter Name="CommunityID"><!-- smallint value --></Parameter>
				<Parameter Name="UniqueID"><!-- varchar value --></Parameter>
				<Parameter Name="PersonIdentificationValues"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="Status">1</Parameter> -->
				<!-- <Parameter Name="NoResult">0</Parameter> -->
				<!-- <Parameter Name="SeparatorInIdentVals">'¶'</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
5)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
6)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/co_getonlinestatus_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)