Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:fo_getpostingcharacs_ad

fo_GetPostingCharacs_Ad

Gibt Merkmale für Postings aus, zu denen Postings Eigenschaften besitzen können.

Grundsätzliches zu Posting-Eigenschaften :
1. Eigenschaften eines Beitrags sind immer an eine „PersonID“ gebunden. Dies bedeutet, daß eine Eigenschaft entweder „allgemein“ gültigt ist - nämlich wenn „PersonID = 0“ ist - oder die Eigenschaft hat nur Gültigkeit für die durch „PersonID“ angegebene Person. Pro Merkmal ist durch das sogenannte „CommonCharacteristic“-Flag (s. Rückgabemenge) konfiguriert, ob

  • nur
  • auch
  • keine

allgemeine(n) Eigenschaften hinterlegt werden können.
2. Genau wie im „Item-“ und „Person-Management“ gehören Eigenschaften immer zu einem Merkmal - Merkmale charakterisieren sozusagen die Eigenschaften.
Wenn für das zugehörige Forum eines Beitrags mindestens ein Merkmal zugeordnet ist (→ fo_ModifyCharacsForForums_Ad), können diesem Beitrag ausschließlich Eigenschaften zu Merkmalen hinzugefügt werden, die dem Forum zugeordnet sind.
3. Sind dem Forum eines Beitrags direkt KEINE Merkmale zugeordnet (→ fo_ModifyCharacsForForums_Ad), können diesem Beitrag ausschließlich Eigenschaften zu Merkmalen hinzugefügt werden, die wenigestens einer Kategorie, in die das Forum DIREKT eingeordnet ist, zugeordnet sind (→ fo_ModifyCharacForForumCats_Ad).

HTTP-MethodGET
HTTP-AuthOptional
Aliasfo_GetPostingCharacteristics_Ad
Tags
Engine-Kategorieforums
Engine-TypDaten-Ermittlung
Letzte Aktualisierung7.0.7 (2015-01-29)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
PostingCharacteristicIDNULL ID eines Posting-Merkmals. Falls angegeben, werden alle anderen Parameter ignoriert und die Prozedur gibt nur den Datensatz zu dieser ID zurück.
smallint4.0.16
GetAssignedForumsOrCategories0 Wenn nicht „0“ angegeben wird, gibt es zusätzliche Informationen im Ergebnis :
„1“ : Pro Merkmal werden alle Foren ausgegeben, denen das Merkmal zugeordnet ist
„2“ : Pro Merkmal werden alle Foren-Kategorien ausgegeben, denen das Merkmal zugeordnet ist
tinyint4.0.16
CharacsAssignedToForumIDNULL ID eines Forums. Wird nur beachtet, wenn „PostingCharacteristicID = NULL“ ist. Falls angegeben, werden „GetAssignedForumsOrCategories“ und „CharacsAssignedToCategoryID“ ignoriert und die Prozedur liefert alle Merkmale, die diesem Forum zugeordnet sind.
smallint4.0.16
CharacsAssignedToCategoryIDNULL ID einer Forums-Kategorie. Wird nur beachtet, wenn „PostingCharacteristicID“ und „CharacsAssignedToForumID“ beide „NULL“ sind. Falls angegeben, liefert die Prozedur alle Merkmale, die dieser Forum-Kategorie zugeordnet sind.
smallint4.0.16

Rückgabe

wenn CharacsAssignedToForumID is NOT NULL

Spaltenname Beschreibung SQL-Datentyp4) ab Version
PostingCharacteristicIDID eines Posting-Merkmals
smallint4.0.16
CharacteristicDescriptionBezeichnung des Merkmals „PostingCharacteristicID“
varchar(100)4.0.16
FieldTypeIDID eines „Feld-Typs“, von dem alle Eigenschaften des Merkmals „PostingCharacteristicID“ sein müssen (z.B. „Text mit maximal 20 Zeichen“)
tinyint4.0.16
FieldTypeDescriptionBezeichnung des Feld-Typs „FieldTypeID“, z.B. „Ganze Zahlen von -999 bis 999“ oder „Text - 20 Zeichen“
varchar(100)4.0.16
BasicFieldTypeIDID des Basis-Feld-Typs, der „FieldTypeID“ zugrunde liegt (siehe auch mi_GetFieldTypes_Ad)
tinyint4.0.16
BasicFieldTypeBezeichnung des Basis-Feld-Typs (z.B. „Zahl“)
varchar(20)4.0.16
MaxLengthMaximale Anzahl Zeichen, die Eigenschaften zum Merkmal „PostingCharacteristicID“ haben dürfen
tinyint4.0.16
PrecisionValueGilt nur für Datentypen mit Basis-Daten-Typ „Zahl“ und gibt die Anzahl erlaubter Nachkommastellen an, die in Eigenschaften zum Merkmal „PostingCharacteristicID“ vorkommen dürfen.
tinyint4.0.16
FormatVon welchem „Format“ (so etwas wie ein regulären Ausdruck) müssen die Eigenschaften zum Merkmal „PostingCharacteristicID“ sein. Derzeit nicht implementiert und verwendet !
varchar(255)4.0.16
PropertyModificationAllowedGibt an, ob Eigenschaften zum Merkmal nachträglich geändert werden können. Es ist eine Summe folgender Werte :
„0“ : Hinzufügen, Ändern oder Löschen ist NICHT möglich
„1“ : Hinzufügen ist möglich
„2“ : Ändern ist möglich
„4“ : Löschen ist möglich
tinyint4.0.16
CommonCharacteristicGibt an, zu welchen „PersonID“s Eigenschaften zum Merkmal hinterlegt werden können :
„0“ : Nur „PersonID“s ungleich „0“
„1“ : „PersonID“ kann beliebig sein
„2“ : Nur „PersonID = 0“
tinyint4.0.16
PredefinedValuesSind mögliche Eigenschaften für Postings zum Merkmal vordefiniert („1“) oder nicht („0“)
bit4.0.16
CheckPostingVisibility„1“ bedeutet, daß das LESEN von Eigenschaften zum Merkmal (über fo_GetPostingProperties_Pu) nur erlaubt ist, wenn die identifizierte Person auch den Beitrag lesen darf - was ja vom „Visible“-Status des jeweiligen Beitrags abhängt
bit4.0.16
MaxNumberOfPropertiesGibt an, wieviele Eigenschaften zum Merkmal ein Beitrag (bei gleicher „PersonID“) maximal haben darf :
- „NULL“ : Keine Einschränkung
- „0“ : Dieser Wert ist nicht erlaubt
- „1“ : Maximal 1 Eigenschaft
- „2“ : Maximal 2 Eigenschaften
usw.
tinyint4.0.16
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • CharacteristicDescription (aufsteigend)

wenn CharacsAssignedToCategoryID is NOT NULL

Spaltenname Beschreibung SQL-Datentyp5) ab Version
PostingCharacteristicIDID eines Posting-Merkmals
smallint4.0.16
CharacteristicDescriptionBezeichnung des Merkmals „PostingCharacteristicID“
varchar(100)4.0.16
FieldTypeIDID eines „Feld-Typs“, von dem alle Eigenschaften des Merkmals „PostingCharacteristicID“ sein müssen (z.B. „Text mit maximal 20 Zeichen“)
tinyint4.0.16
FieldTypeDescriptionBezeichnung des Feld-Typs „FieldTypeID“, z.B. „Ganze Zahlen von -999 bis 999“ oder „Text - 20 Zeichen“
varchar(100)4.0.16
BasicFieldTypeIDID des Basis-Feld-Typs, der „FieldTypeID“ zugrunde liegt (siehe auch mi_GetFieldTypes_Ad)
tinyint4.0.16
BasicFieldTypeBezeichnung des Basis-Feld-Typs (z.B. „Zahl“)
varchar(20)4.0.16
MaxLengthMaximale Anzahl Zeichen, die Eigenschaften zum Merkmal „PostingCharacteristicID“ haben dürfen
tinyint4.0.16
PrecisionValueGilt nur für Datentypen mit Basis-Daten-Typ „Zahl“ und gibt die Anzahl erlaubter Nachkommastellen an, die in Eigenschaften zum Merkmal „PostingCharacteristicID“ vorkommen dürfen.
tinyint4.0.16
FormatVon welchem „Format“ (so etwas wie ein regulären Ausdruck) müssen die Eigenschaften zum Merkmal „PostingCharacteristicID“ sein. Derzeit nicht implementiert und verwendet !
varchar(255)4.0.16
PropertyModificationAllowedGibt an, ob Eigenschaften zum Merkmal nachträglich geändert werden können. Es ist eine Summe folgender Werte :
„0“ : Hinzufügen, Ändern oder Löschen ist NICHT möglich
„1“ : Hinzufügen ist möglich
„2“ : Ändern ist möglich
„4“ : Löschen ist möglich
tinyint4.0.16
CommonCharacteristicGibt an, zu welchen „PersonID“s Eigenschaften zum Merkmal hinterlegt werden können :
„0“ : Nur „PersonID“s ungleich „0“
„1“ : „PersonID“ kann beliebig sein
„2“ : Nur „PersonID = 0“
tinyint4.0.16
PredefinedValuesSind mögliche Eigenschaften für Postings zum Merkmal vordefiniert („1“) oder nicht („0“)
bit4.0.16
CheckPostingVisibility„1“ bedeutet, daß das LESEN von Eigenschaften zum Merkmal (über fo_GetPostingProperties_Pu) nur erlaubt ist, wenn die identifizierte Person auch den Beitrag lesen darf - was ja vom „Visible“-Status des jeweiligen Beitrags abhängt
bit4.0.16
MaxNumberOfPropertiesGibt an, wieviele Eigenschaften zum Merkmal ein Beitrag (bei gleicher „PersonID“) maximal haben darf :
- „NULL“ : Keine Einschränkung
- „0“ : Dieser Wert ist nicht erlaubt
- „1“ : Maximal 1 Eigenschaft
- „2“ : Maximal 2 Eigenschaften
usw.
tinyint4.0.16
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • CharacteristicDescription (aufsteigend)

wenn CharacsAssignedToForumID is NULL und GetAssignedForumsOrCategories = 0 und CharacsAssignedToCategoryID is NULL

Spaltenname Beschreibung SQL-Datentyp6) ab Version
PostingCharacteristicIDID eines Posting-Merkmals
smallint4.0.16
CharacteristicDescriptionBezeichnung des Merkmals „PostingCharacteristicID“
varchar(100)4.0.16
FieldTypeIDID eines „Feld-Typs“, von dem alle Eigenschaften des Merkmals „PostingCharacteristicID“ sein müssen (z.B. „Text mit maximal 20 Zeichen“)
tinyint4.0.16
FieldTypeDescriptionBezeichnung des Feld-Typs „FieldTypeID“, z.B. „Ganze Zahlen von -999 bis 999“ oder „Text - 20 Zeichen“
varchar(100)4.0.16
BasicFieldTypeIDID des Basis-Feld-Typs, der „FieldTypeID“ zugrunde liegt (siehe auch mi_GetFieldTypes_Ad)
tinyint4.0.16
BasicFieldTypeBezeichnung des Basis-Feld-Typs (z.B. „Zahl“)
varchar(20)4.0.16
MaxLengthMaximale Anzahl Zeichen, die Eigenschaften zum Merkmal „PostingCharacteristicID“ haben dürfen
tinyint4.0.16
PrecisionValueGilt nur für Datentypen mit Basis-Daten-Typ „Zahl“ und gibt die Anzahl erlaubter Nachkommastellen an, die in Eigenschaften zum Merkmal „PostingCharacteristicID“ vorkommen dürfen.
tinyint4.0.16
FormatVon welchem „Format“ (so etwas wie ein regulären Ausdruck) müssen die Eigenschaften zum Merkmal „PostingCharacteristicID“ sein. Derzeit nicht implementiert und verwendet !
varchar(255)4.0.16
PropertyModificationAllowedGibt an, ob Eigenschaften zum Merkmal nachträglich geändert werden können. Es ist eine Summe folgender Werte :
„0“ : Hinzufügen, Ändern oder Löschen ist NICHT möglich
„1“ : Hinzufügen ist möglich
„2“ : Ändern ist möglich
„4“ : Löschen ist möglich
tinyint4.0.16
CommonCharacteristicGibt an, zu welchen „PersonID“s Eigenschaften zum Merkmal hinterlegt werden können :
„0“ : Nur „PersonID“s ungleich „0“
„1“ : „PersonID“ kann beliebig sein
„2“ : Nur „PersonID = 0“
tinyint4.0.16
PredefinedValuesSind mögliche Eigenschaften für Postings zum Merkmal vordefiniert („1“) oder nicht („0“)
bit4.0.16
CheckPostingVisibility„1“ bedeutet, daß das LESEN von Eigenschaften zum Merkmal (über fo_GetPostingProperties_Pu) nur erlaubt ist, wenn die identifizierte Person auch den Beitrag lesen darf - was ja vom „Visible“-Status des jeweiligen Beitrags abhängt
bit4.0.16
MaxNumberOfPropertiesGibt an, wieviele Eigenschaften zum Merkmal ein Beitrag (bei gleicher „PersonID“) maximal haben darf :
- „NULL“ : Keine Einschränkung
- „0“ : Dieser Wert ist nicht erlaubt
- „1“ : Maximal 1 Eigenschaft
- „2“ : Maximal 2 Eigenschaften
usw.
tinyint4.0.16
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • CharacteristicDescription (aufsteigend)

wenn CharacsAssignedToForumID is NULL und GetAssignedForumsOrCategories = 1 und CharacsAssignedToCategoryID is NULL

Spaltenname Beschreibung SQL-Datentyp7) ab Version
PostingCharacteristicIDID eines Posting-Merkmals
smallint4.0.16
CharacteristicDescriptionBezeichnung des Merkmals „PostingCharacteristicID“
varchar(100)4.0.16
FieldTypeIDID eines „Feld-Typs“, von dem alle Eigenschaften des Merkmals „PostingCharacteristicID“ sein müssen (z.B. „Text mit maximal 20 Zeichen“)
tinyint4.0.16
FieldTypeDescriptionBezeichnung des Feld-Typs „FieldTypeID“, z.B. „Ganze Zahlen von -999 bis 999“ oder „Text - 20 Zeichen“
varchar(100)4.0.16
BasicFieldTypeIDID des Basis-Feld-Typs, der „FieldTypeID“ zugrunde liegt (siehe auch mi_GetFieldTypes_Ad)
tinyint4.0.16
BasicFieldTypeBezeichnung des Basis-Feld-Typs (z.B. „Zahl“)
varchar(20)4.0.16
MaxLengthMaximale Anzahl Zeichen, die Eigenschaften zum Merkmal „PostingCharacteristicID“ haben dürfen
tinyint4.0.16
PrecisionValueGilt nur für Datentypen mit Basis-Daten-Typ „Zahl“ und gibt die Anzahl erlaubter Nachkommastellen an, die in Eigenschaften zum Merkmal „PostingCharacteristicID“ vorkommen dürfen.
tinyint4.0.16
FormatVon welchem „Format“ (so etwas wie ein regulären Ausdruck) müssen die Eigenschaften zum Merkmal „PostingCharacteristicID“ sein. Derzeit nicht implementiert und verwendet !
varchar(255)4.0.16
PropertyModificationAllowedGibt an, ob Eigenschaften zum Merkmal nachträglich geändert werden können. Es ist eine Summe folgender Werte :
„0“ : Hinzufügen, Ändern oder Löschen ist NICHT möglich
„1“ : Hinzufügen ist möglich
„2“ : Ändern ist möglich
„4“ : Löschen ist möglich
tinyint4.0.16
CommonCharacteristicGibt an, zu welchen „PersonID“s Eigenschaften zum Merkmal hinterlegt werden können :
„0“ : Nur „PersonID“s ungleich „0“
„1“ : „PersonID“ kann beliebig sein
„2“ : Nur „PersonID = 0“
tinyint4.0.16
PredefinedValuesSind mögliche Eigenschaften für Postings zum Merkmal vordefiniert („1“) oder nicht („0“)
bit4.0.16
CheckPostingVisibility„1“ bedeutet, daß das LESEN von Eigenschaften zum Merkmal (über fo_GetPostingProperties_Pu) nur erlaubt ist, wenn die identifizierte Person auch den Beitrag lesen darf - was ja vom „Visible“-Status des jeweiligen Beitrags abhängt
bit4.0.16
MaxNumberOfPropertiesGibt an, wieviele Eigenschaften zum Merkmal ein Beitrag (bei gleicher „PersonID“) maximal haben darf :
- „NULL“ : Keine Einschränkung
- „0“ : Dieser Wert ist nicht erlaubt
- „1“ : Maximal 1 Eigenschaft
- „2“ : Maximal 2 Eigenschaften
usw.
tinyint4.0.16
ForumIDID eines Forums, dem das Merkmal (direkt) zugeordnet ist
smallint4.0.16
ForumNameName des Forums „ForumID“
varchar(100)4.0.16
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • CharacteristicDescription (aufsteigend)
  • ForumName (aufsteigend)

wenn CharacsAssignedToForumID is NULL und GetAssignedForumsOrCategories = 2 und CharacsAssignedToCategoryID is NULL

Spaltenname Beschreibung SQL-Datentyp8) ab Version
PostingCharacteristicIDID eines Posting-Merkmals
smallint4.0.16
CharacteristicDescriptionBezeichnung des Merkmals „PostingCharacteristicID“
varchar(100)4.0.16
FieldTypeIDID eines „Feld-Typs“, von dem alle Eigenschaften des Merkmals „PostingCharacteristicID“ sein müssen (z.B. „Text mit maximal 20 Zeichen“)
tinyint4.0.16
FieldTypeDescriptionBezeichnung des Feld-Typs „FieldTypeID“, z.B. „Ganze Zahlen von -999 bis 999“ oder „Text - 20 Zeichen“
varchar(100)4.0.16
BasicFieldTypeIDID des Basis-Feld-Typs, der „FieldTypeID“ zugrunde liegt (siehe auch mi_GetFieldTypes_Ad)
tinyint4.0.16
BasicFieldTypeBezeichnung des Basis-Feld-Typs (z.B. „Zahl“)
varchar(20)4.0.16
MaxLengthMaximale Anzahl Zeichen, die Eigenschaften zum Merkmal „PostingCharacteristicID“ haben dürfen
tinyint4.0.16
PrecisionValueGilt nur für Datentypen mit Basis-Daten-Typ „Zahl“ und gibt die Anzahl erlaubter Nachkommastellen an, die in Eigenschaften zum Merkmal „PostingCharacteristicID“ vorkommen dürfen.
tinyint4.0.16
FormatVon welchem „Format“ (so etwas wie ein regulären Ausdruck) müssen die Eigenschaften zum Merkmal „PostingCharacteristicID“ sein. Derzeit nicht implementiert und verwendet !
varchar(255)4.0.16
PropertyModificationAllowedGibt an, ob Eigenschaften zum Merkmal nachträglich geändert werden können. Es ist eine Summe folgender Werte :
„0“ : Hinzufügen, Ändern oder Löschen ist NICHT möglich
„1“ : Hinzufügen ist möglich
„2“ : Ändern ist möglich
„4“ : Löschen ist möglich
tinyint4.0.16
CommonCharacteristicGibt an, zu welchen „PersonID“s Eigenschaften zum Merkmal hinterlegt werden können :
„0“ : Nur „PersonID“s ungleich „0“
„1“ : „PersonID“ kann beliebig sein
„2“ : Nur „PersonID = 0“
tinyint4.0.16
PredefinedValuesSind mögliche Eigenschaften für Postings zum Merkmal vordefiniert („1“) oder nicht („0“)
bit4.0.16
CheckPostingVisibility„1“ bedeutet, daß das LESEN von Eigenschaften zum Merkmal (über fo_GetPostingProperties_Pu) nur erlaubt ist, wenn die identifizierte Person auch den Beitrag lesen darf - was ja vom „Visible“-Status des jeweiligen Beitrags abhängt
bit4.0.16
MaxNumberOfPropertiesGibt an, wieviele Eigenschaften zum Merkmal ein Beitrag (bei gleicher „PersonID“) maximal haben darf :
- „NULL“ : Keine Einschränkung
- „0“ : Dieser Wert ist nicht erlaubt
- „1“ : Maximal 1 Eigenschaft
- „2“ : Maximal 2 Eigenschaften
usw.
tinyint4.0.16
ForumCategoryIDID einer Forum-Kategorie, dem das Merkmal zugeordnet ist
smallint4.0.16
CategoryDescriptionBezeichnung der Kategorie „ForumCategoryID“
varchar(100)4.0.16
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • CharacteristicDescription (aufsteigend)
  • CategoryDescription (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 9)
-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
-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
-500Falsche Parameterdirekt und 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-29Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
4.0.16 2004-08-31Erstmalig 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/fo_GetPostingCharacs_Ad'

Mit xmllint 10) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/fo_GetPostingCharacs_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'),
	'fo_GetPostingCharacs_Ad',
		array(
			// 'PostingCharacteristicID' => NULL,
			// 'GetAssignedForumsOrCategories' => 0,
			// 'CharacsAssignedToForumID' => NULL,
			// 'CharacsAssignedToCategoryID' => 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="fo_GetPostingCharacs_Ad">
			<Parameters>
				<!-- <Parameter Name="PostingCharacteristicID">NULL</Parameter> -->
				<!-- <Parameter Name="GetAssignedForumsOrCategories">0</Parameter> -->
				<!-- <Parameter Name="CharacsAssignedToForumID">NULL</Parameter> -->
				<!-- <Parameter Name="CharacsAssignedToCategoryID">NULL</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
9)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
10)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/fo_getpostingcharacs_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)