Verwaltet „Beziehungen“ von Personen. Darunter sind Zuordnungen einer Person zu einer anderen Person zu verstehen, wobei immer angegeben ist, welcher Art die Beziehung ist, in welchem Zeitraum sie gültig ist und welche Zugriffsrechte bestehen.
Anmerkung zum Parameter „SortNo“ :
Soll ein neuer Datensatz, d.h. eine neue Beziehung, angelegt werden, kann dieser Parameter entweder angegeben werden (der Wert muß „>= 1“ sein !) oder auf „NULL“ gesetzt werden. In letzterem Fall generiert die Prozedur automatisch eine „SortNo“, und zwar so, daß die neue Beziehung die niedrigste Priorität besitzt.
Anmerkungen zum Parameter „AccessLevel“ :
1.) Wird hier „NULL“ übergeben, gilt folgendes :
Bei Neu-Anlage einer Beziehung suchen wir nach einer zu den Personentypen von „PersonID“ und „RelatedPersonID“ sowie der „RelationshipID“ passenden Einstellung zum Schlüssel „DefaultAccessLevels“ und übernehmen diese ggf. Ansonsten wird der Wert „0“ gewählt, was bedeutet, daß „PersonID“ KEINE Zugriffsrechte auf die Daten von „RelatedPersonID“ hat.
Bei Änderung einer bestehenden Beziehung bedeutet „NULL“, daß das vorhandene Zugriffsrecht NICHT geändert werden soll.
2.) Ist dieser Parameter angegeben, und soll eine bestehende Beziehung geändert werden (ist also „OldValidFrom“ NICHT „NULL“), und ist der Wert ANDERS als der bestehende, werden „SortNo“, „ValidFrom“ UND „ValidTo“ IGNORIERT !
3.) Es handelt sich um eine „Summe“ von Zugriffsrechten (mögliche Einzel-Zugriffsrechte : s. pm_GetRelationAccessLevels), die „PersonID“ auf „RelatedPersonID“ hat.
4.) Eine tatsächliche Änderung des „AccessLevel“ („OldValidFrom“ NICHT „NULL“, „AccessLevel“ anders als der bestehende) löst intern ZWEI Schritte aus :
Ausnahme : Der Zeitraum liegt in der Zukunft, dann wird der Wert tatsächlich einfach geändert
5.) Wird ein Zugriffrecht gesetzt oder geändert (ist also „AccessLevel > 0“), muß in „RelationshipSettings“ zur „RelationshipID“ zum Schlüssel „AllowedAccessLevels“ ein für die beiden Personentypen (von „PersonID“ und „RelatedPersonID“) gültiger Eintrag konfiguriert sein (s. pm_GetRelationshipSettingEntry), der angibt, welche Zugriffsrechte maximal vergeben werden können. Verletzt „AccessLevel“ diese Bedingung, gibt es einen Fehler.
HTTP-Method | POST |
HTTP-Auth | Optional |
Tags | |
Engine-Kategorie | person management |
Engine-Typ | Daten-Änderung |
Letzte Aktualisierung | 7.0.7 (2015-01-29) |
Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
---|---|---|---|---|
PersonID | ID einer Person, für die eine Beziehung zur Person „RelatedPersonID“ erstellt oder geändert werden soll. Muß größer als „0“ sein (IDs kleiner „0“ gibt es sowieso nicht, und die ID „0“ ist für die „anonyme“ oder „allgemeine“ Person reserviert) ! | integer | 3.5.10 | |
RelatedPersonID | ID der Person, die zu „PersonID“ in Beziehung steht oder stehen soll. Muß größer als „0“ sein (IDs kleiner „0“ gibt es sowieso nicht, und die ID „0“ ist für die „anonyme“ oder „allgemeine“ Person reserviert) ! | integer | 3.5.10 | |
RelationshipID | ID der Art von Beziehung, die zwischen „PersonID“ und „RelatedPersonID“ besteht bzw. bestehen soll (mögliche Werte, siehe pm_GetRelationships_Ad) | tinyint | 3.5.10 | |
SortNo | NULL | Bestimmt die Reihenfolge bzw. „Priorität“ der Beziehung (von „PersonID“) zur Person „RelatedPersonID“ innerhalb aller Personen, die (bei gleicher „RelationshipID“) zur „PersonID“ in Beziehung stehen. (siehe Beschreibung) | integer | 3.5.10 |
ValidFrom | Zeitpunkt, AB dem die Beziehung gültig ist. Ist „NULL“ angegeben, wird automatisch der aktuelle Zeitpunkt gewählt. | datetime | 3.5.10 | |
ValidTo | NULL | Zeitpunkt, BIS zu dem die Beziehung gültig ist. „NULL“ bedeutet, daß die Beziehung zunächst unbeschränkt besteht (kann später noch geändert werden). Falls angegeben, muß natürlich „ValidFrom < ValidTo“ gelten. | datetime | 3.5.10 |
OldValidFrom | NULL | Angeben, um einen besteh. Datensatz („ValidFrom = OldValidFrom“) zu ändern - „SortNo“, „ValidFrom“, „ValidTo“ u. „AccessLevel“ können geändert werden. Bei „NULL“ wird je nach „DeletePersonRelationship“ ein neuer Datensatz angel. o. ein besteh. gelöscht. | datetime | 3.5.10 |
DeletePersonRelationship | 0 | Wird nur im Fall „OldValidFrom = NULL“ beachtet ! Ist „1“ angegeben, wird der Datensatz zu „PersonID“, „RelatedPersonID“, „RelationshipID“ und „ValidFrom“ gelöscht, sofern „ValidFrom“ in der Zukunft liegt. Sonst wird eine neue Beziehung erstellt. | bit | 3.5.10 |
AccessLevel | NULL | Summe von Zugriffsrechten, die „PersonID“ auf Daten von „RelatdPersonID“ haben soll. Mögliche Einzel-Zugriffsrechte : s. pm_GetRelationAccessLevels. s. Beschreibung ! | smallint | 5.1.10 |
Die Prozedur hat keine Rückgaben.
Die Prozedur hat keine Output-Parameter.
Code | Beschreibung | Quelle 4) |
---|---|---|
-679 | Mind. ein Zugriffsrecht darf aufgrund eines „RelationshipSettings“-Eintrags nicht vergeben werden | nur direkt |
-624 | Fehlender oder falscher Eintrag in RelationshipSettings | 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 |
-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 |
-500 | Falsche Parameter | direkt und indirekt |
Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.
7.0.7 | 2015-01-29 | Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf] |
7.0.2 | 2013-08-29 | Implementierung des neuen „RelationshipSettings“-Schlüssels „DefaultAccessLevels“ ⇒ Auch Hinweis in der Doku |
5.1.10 | 2007-03-12 | 1. „RelationshipID“ ist jetzt ein „tinyint“ 2. Neuer Parameter „AccessLevel“ 3. Ab jetzt kann ein vorhandener Datensatz nur gelöscht werden, wenn der Beginn des Gültigkeitszeitraum in der ZUKUNFT liegt |
5.1.0 | 2006-02-08 | Ab jetzt ist es verboten für „PersonID“ oder „RelatedPersonID“ den Wert „0“ anzugeben |
4.0.15 | 2004-07-30 | 1. Aufruf der Prozeduren „_mi_StartProcedure“ und „_mi_FinishProcedure“ 2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur 3. Konsequente Fehlerbehandlung |
3.5.11 | 2001-09-06 | |
3.5.10 | 2001-07-14 | 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 POST 'http://<partner>-<project>.dstore.de/default/engine/pm_ModifyPersonRelationship_Ad?PersonID=<value>&RelatedPersonID=<value>&RelationshipID=<value>&ValidFrom=<value>'
Mit xmllint 5) formatierte Ausgabe:
curl -X POST 'http://<partner>-<project>.dstore.de/default/engine/pm_ModifyPersonRelationship_Ad?PersonID=<value>&RelatedPersonID=<value>&RelationshipID=<value>&ValidFrom=<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_ModifyPersonRelationship_Ad', array( 'PersonID' => <value>, 'RelatedPersonID' => <value>, 'RelationshipID' => <value>, 'ValidFrom' => <value>, // 'SortNo' => NULL, // 'ValidTo' => NULL, // 'OldValidFrom' => NULL, // 'DeletePersonRelationship' => 0, // 'AccessLevel' => NULL ) ); $service->execute($request); $xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument(); $ResultSet = $xml_result->getRowsAsArray();
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_ModifyPersonRelationship_Ad"> <Parameters> <Parameter Name="PersonID"><!-- integer value --></Parameter> <Parameter Name="RelatedPersonID"><!-- integer value --></Parameter> <Parameter Name="RelationshipID"><!-- tinyint value --></Parameter> <Parameter Name="ValidFrom"><!-- datetime value --></Parameter> <!-- <Parameter Name="SortNo">NULL</Parameter> --> <!-- <Parameter Name="ValidTo">NULL</Parameter> --> <!-- <Parameter Name="OldValidFrom">NULL</Parameter> --> <!-- <Parameter Name="DeletePersonRelationship">0</Parameter> --> <!-- <Parameter Name="AccessLevel">NULL</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>