Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
engine:procedures:fo_getpostingcharacs_ad [11.01.2016 ] |
engine:procedures:fo_getpostingcharacs_ad [11.01.2016 ] (aktuell) |
||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
+ | ===== 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 (-> [[dstoreproc>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 (-> [[dstoreproc>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 (-> [[dstoreproc>fo_ModifyCharacForForumCats_Ad]]).\\ | ||
+ | |HTTP-Method|GET | | ||
+ | |HTTP-Auth|Optional | | ||
+ | |Alias|fo_GetPostingCharacteristics_Ad | | ||
+ | |Tags|{{tag>[fo Get Posting Characteristics Ad]}}| | ||
+ | |Engine-Kategorie|forums | | ||
+ | |Engine-Typ|Daten-Ermittlung | | ||
+ | |Letzte Aktualisierung|7.0.7 (2015-01-29)| | ||
+ | |||
+ | ==== Parameter ==== | ||
+ | |||
+ | ^Name ((Pflichtparameter sind unterstrichen)) ^Standard-Wert ^Beschreibung ((siehe [[webservice:engine_parameterconventions|Parameter-Konventionen engine/<Prozedur-Name>]])) ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
+ | |PostingCharacteristicID|NULL |ID eines Posting-Merkmals. Falls angegeben, werden alle anderen Parameter ignoriert und die Prozedur gibt nur den Datensatz zu dieser ID zurück.\\ |smallint|4.0.16| | ||
+ | |GetAssignedForumsOrCategories|0 |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\\ |tinyint|4.0.16| | ||
+ | |CharacsAssignedToForumID|NULL |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.\\ |smallint|4.0.16| | ||
+ | |CharacsAssignedToCategoryID|NULL |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.\\ |smallint|4.0.16| | ||
+ | ==== Rückgabe ==== | ||
+ | |||
+ | === wenn CharacsAssignedToForumID is NOT NULL === | ||
+ | |||
+ | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
+ | |PostingCharacteristicID|ID eines Posting-Merkmals\\ |smallint|4.0.16 | | ||
+ | |CharacteristicDescription|Bezeichnung des Merkmals "PostingCharacteristicID"\\ |varchar(100)|4.0.16 | | ||
+ | |FieldTypeID|ID eines "Feld-Typs", von dem alle Eigenschaften des Merkmals "PostingCharacteristicID" sein müssen (z.B. "Text mit maximal 20 Zeichen")\\ |tinyint|4.0.16 | | ||
+ | |FieldTypeDescription|Bezeichnung des Feld-Typs "FieldTypeID", z.B. "Ganze Zahlen von -999 bis 999" oder "Text - 20 Zeichen"\\ |varchar(100)|4.0.16 | | ||
+ | |BasicFieldTypeID|ID des Basis-Feld-Typs, der "FieldTypeID" zugrunde liegt (siehe auch [[dstoreproc>mi_GetFieldTypes_Ad]])\\ |tinyint|4.0.16 | | ||
+ | |BasicFieldType|Bezeichnung des Basis-Feld-Typs (z.B. "Zahl")\\ |varchar(20)|4.0.16 | | ||
+ | |MaxLength|Maximale Anzahl Zeichen, die Eigenschaften zum Merkmal "PostingCharacteristicID" haben dürfen\\ |tinyint|4.0.16 | | ||
+ | |PrecisionValue|Gilt 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.\\ |tinyint|4.0.16 | | ||
+ | |Format|Von 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 | | ||
+ | |PropertyModificationAllowed|Gibt 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\\ |tinyint|4.0.16 | | ||
+ | |CommonCharacteristic|Gibt 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"\\ |tinyint|4.0.16 | | ||
+ | |PredefinedValues|Sind mögliche Eigenschaften für Postings zum Merkmal vordefiniert ("1") oder nicht ("0")\\ |bit|4.0.16 | | ||
+ | |CheckPostingVisibility|"1" bedeutet, daß das LESEN von Eigenschaften zum Merkmal (über [[dstoreproc>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\\ |bit|4.0.16 | | ||
+ | |MaxNumberOfProperties|Gibt 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.\\ |tinyint|4.0.16 | | ||
+ | |||
+ | == Sortierung der Rückgabe == | ||
+ | |||
+ | (parameterunabängige Sortierung) | ||
+ | * CharacteristicDescription (aufsteigend) | ||
+ | |||
+ | === wenn CharacsAssignedToCategoryID is NOT NULL === | ||
+ | |||
+ | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
+ | |PostingCharacteristicID|ID eines Posting-Merkmals\\ |smallint|4.0.16 | | ||
+ | |CharacteristicDescription|Bezeichnung des Merkmals "PostingCharacteristicID"\\ |varchar(100)|4.0.16 | | ||
+ | |FieldTypeID|ID eines "Feld-Typs", von dem alle Eigenschaften des Merkmals "PostingCharacteristicID" sein müssen (z.B. "Text mit maximal 20 Zeichen")\\ |tinyint|4.0.16 | | ||
+ | |FieldTypeDescription|Bezeichnung des Feld-Typs "FieldTypeID", z.B. "Ganze Zahlen von -999 bis 999" oder "Text - 20 Zeichen"\\ |varchar(100)|4.0.16 | | ||
+ | |BasicFieldTypeID|ID des Basis-Feld-Typs, der "FieldTypeID" zugrunde liegt (siehe auch [[dstoreproc>mi_GetFieldTypes_Ad]])\\ |tinyint|4.0.16 | | ||
+ | |BasicFieldType|Bezeichnung des Basis-Feld-Typs (z.B. "Zahl")\\ |varchar(20)|4.0.16 | | ||
+ | |MaxLength|Maximale Anzahl Zeichen, die Eigenschaften zum Merkmal "PostingCharacteristicID" haben dürfen\\ |tinyint|4.0.16 | | ||
+ | |PrecisionValue|Gilt 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.\\ |tinyint|4.0.16 | | ||
+ | |Format|Von 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 | | ||
+ | |PropertyModificationAllowed|Gibt 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\\ |tinyint|4.0.16 | | ||
+ | |CommonCharacteristic|Gibt 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"\\ |tinyint|4.0.16 | | ||
+ | |PredefinedValues|Sind mögliche Eigenschaften für Postings zum Merkmal vordefiniert ("1") oder nicht ("0")\\ |bit|4.0.16 | | ||
+ | |CheckPostingVisibility|"1" bedeutet, daß das LESEN von Eigenschaften zum Merkmal (über [[dstoreproc>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\\ |bit|4.0.16 | | ||
+ | |MaxNumberOfProperties|Gibt 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.\\ |tinyint|4.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-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
+ | |PostingCharacteristicID|ID eines Posting-Merkmals\\ |smallint|4.0.16 | | ||
+ | |CharacteristicDescription|Bezeichnung des Merkmals "PostingCharacteristicID"\\ |varchar(100)|4.0.16 | | ||
+ | |FieldTypeID|ID eines "Feld-Typs", von dem alle Eigenschaften des Merkmals "PostingCharacteristicID" sein müssen (z.B. "Text mit maximal 20 Zeichen")\\ |tinyint|4.0.16 | | ||
+ | |FieldTypeDescription|Bezeichnung des Feld-Typs "FieldTypeID", z.B. "Ganze Zahlen von -999 bis 999" oder "Text - 20 Zeichen"\\ |varchar(100)|4.0.16 | | ||
+ | |BasicFieldTypeID|ID des Basis-Feld-Typs, der "FieldTypeID" zugrunde liegt (siehe auch [[dstoreproc>mi_GetFieldTypes_Ad]])\\ |tinyint|4.0.16 | | ||
+ | |BasicFieldType|Bezeichnung des Basis-Feld-Typs (z.B. "Zahl")\\ |varchar(20)|4.0.16 | | ||
+ | |MaxLength|Maximale Anzahl Zeichen, die Eigenschaften zum Merkmal "PostingCharacteristicID" haben dürfen\\ |tinyint|4.0.16 | | ||
+ | |PrecisionValue|Gilt 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.\\ |tinyint|4.0.16 | | ||
+ | |Format|Von 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 | | ||
+ | |PropertyModificationAllowed|Gibt 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\\ |tinyint|4.0.16 | | ||
+ | |CommonCharacteristic|Gibt 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"\\ |tinyint|4.0.16 | | ||
+ | |PredefinedValues|Sind mögliche Eigenschaften für Postings zum Merkmal vordefiniert ("1") oder nicht ("0")\\ |bit|4.0.16 | | ||
+ | |CheckPostingVisibility|"1" bedeutet, daß das LESEN von Eigenschaften zum Merkmal (über [[dstoreproc>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\\ |bit|4.0.16 | | ||
+ | |MaxNumberOfProperties|Gibt 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.\\ |tinyint|4.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-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
+ | |PostingCharacteristicID|ID eines Posting-Merkmals\\ |smallint|4.0.16 | | ||
+ | |CharacteristicDescription|Bezeichnung des Merkmals "PostingCharacteristicID"\\ |varchar(100)|4.0.16 | | ||
+ | |FieldTypeID|ID eines "Feld-Typs", von dem alle Eigenschaften des Merkmals "PostingCharacteristicID" sein müssen (z.B. "Text mit maximal 20 Zeichen")\\ |tinyint|4.0.16 | | ||
+ | |FieldTypeDescription|Bezeichnung des Feld-Typs "FieldTypeID", z.B. "Ganze Zahlen von -999 bis 999" oder "Text - 20 Zeichen"\\ |varchar(100)|4.0.16 | | ||
+ | |BasicFieldTypeID|ID des Basis-Feld-Typs, der "FieldTypeID" zugrunde liegt (siehe auch [[dstoreproc>mi_GetFieldTypes_Ad]])\\ |tinyint|4.0.16 | | ||
+ | |BasicFieldType|Bezeichnung des Basis-Feld-Typs (z.B. "Zahl")\\ |varchar(20)|4.0.16 | | ||
+ | |MaxLength|Maximale Anzahl Zeichen, die Eigenschaften zum Merkmal "PostingCharacteristicID" haben dürfen\\ |tinyint|4.0.16 | | ||
+ | |PrecisionValue|Gilt 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.\\ |tinyint|4.0.16 | | ||
+ | |Format|Von 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 | | ||
+ | |PropertyModificationAllowed|Gibt 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\\ |tinyint|4.0.16 | | ||
+ | |CommonCharacteristic|Gibt 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"\\ |tinyint|4.0.16 | | ||
+ | |PredefinedValues|Sind mögliche Eigenschaften für Postings zum Merkmal vordefiniert ("1") oder nicht ("0")\\ |bit|4.0.16 | | ||
+ | |CheckPostingVisibility|"1" bedeutet, daß das LESEN von Eigenschaften zum Merkmal (über [[dstoreproc>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\\ |bit|4.0.16 | | ||
+ | |MaxNumberOfProperties|Gibt 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.\\ |tinyint|4.0.16 | | ||
+ | |ForumID|ID eines Forums, dem das Merkmal (direkt) zugeordnet ist\\ |smallint|4.0.16 | | ||
+ | |ForumName|Name 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-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
+ | |PostingCharacteristicID|ID eines Posting-Merkmals\\ |smallint|4.0.16 | | ||
+ | |CharacteristicDescription|Bezeichnung des Merkmals "PostingCharacteristicID"\\ |varchar(100)|4.0.16 | | ||
+ | |FieldTypeID|ID eines "Feld-Typs", von dem alle Eigenschaften des Merkmals "PostingCharacteristicID" sein müssen (z.B. "Text mit maximal 20 Zeichen")\\ |tinyint|4.0.16 | | ||
+ | |FieldTypeDescription|Bezeichnung des Feld-Typs "FieldTypeID", z.B. "Ganze Zahlen von -999 bis 999" oder "Text - 20 Zeichen"\\ |varchar(100)|4.0.16 | | ||
+ | |BasicFieldTypeID|ID des Basis-Feld-Typs, der "FieldTypeID" zugrunde liegt (siehe auch [[dstoreproc>mi_GetFieldTypes_Ad]])\\ |tinyint|4.0.16 | | ||
+ | |BasicFieldType|Bezeichnung des Basis-Feld-Typs (z.B. "Zahl")\\ |varchar(20)|4.0.16 | | ||
+ | |MaxLength|Maximale Anzahl Zeichen, die Eigenschaften zum Merkmal "PostingCharacteristicID" haben dürfen\\ |tinyint|4.0.16 | | ||
+ | |PrecisionValue|Gilt 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.\\ |tinyint|4.0.16 | | ||
+ | |Format|Von 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 | | ||
+ | |PropertyModificationAllowed|Gibt 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\\ |tinyint|4.0.16 | | ||
+ | |CommonCharacteristic|Gibt 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"\\ |tinyint|4.0.16 | | ||
+ | |PredefinedValues|Sind mögliche Eigenschaften für Postings zum Merkmal vordefiniert ("1") oder nicht ("0")\\ |bit|4.0.16 | | ||
+ | |CheckPostingVisibility|"1" bedeutet, daß das LESEN von Eigenschaften zum Merkmal (über [[dstoreproc>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\\ |bit|4.0.16 | | ||
+ | |MaxNumberOfProperties|Gibt 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.\\ |tinyint|4.0.16 | | ||
+ | |ForumCategoryID|ID einer Forum-Kategorie, dem das Merkmal zugeordnet ist\\ |smallint|4.0.16 | | ||
+ | |CategoryDescription|Bezeichnung 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 ((direkt meint "von der Prozedur selber" und indirekt meint "von intern aufgerufenen Unterprozeduren")) ^ | ||
+ | |-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| | ||
+ | ==== XML-Schema ==== | ||
+ | |||
+ | Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema [[http://resources.dstore.de/xsd/webservice_SmartGate/Response/EngineProcedure_v1_0.xsd|Response/EngineProcedure_v1_0.xsd]] validiert. | ||
+ | ==== Historie ==== | ||
+ | |||
+ | |7.0.7 |2015-01-29|Interne Änderung : Datentyp-Erweiterung des "ReferenceKey" [für "_mi_StartProcedure"-Aufruf]\\ | | ||
+ | |4.0.16 |2004-08-31|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: | ||
+ | * [[http://playground.dstore.de/index.php?proc=fo_GetPostingCharacs_Ad|fo_GetPostingCharacs_Ad im Engine Playground öffnen]] | ||
+ | == cURL == | ||
+ | Unformatierte Ausgabe: | ||
+ | <code bash> | ||
+ | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/fo_GetPostingCharacs_Ad'</code>Mit xmllint ((I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org)) formatierte Ausgabe: | ||
+ | <code bash> | ||
+ | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/fo_GetPostingCharacs_Ad' | xmllint --format -</code>== dStore_php == | ||
+ | <code 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(); | ||
+ | |||
+ | </code> | ||
+ | == engine/execute == | ||
+ | XML zur Ausführung mit der Methode [[:webservice:engine:execute|engine/execute]], z.B. per | ||
+ | curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>' | ||
+ | |||
+ | <code xml> | ||
+ | <?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></code> | ||