ListEventDescendants

From The Contingency Market

Jump to: navigation, search

Contents

ListEventDescendants(ulSessionID,uSequenceID,sIntegrity,sEventID,uGenerations,sParameterType,sPattern,bIncompleteOnly)

List the specified event's descendant events that have a parameter name matching a given pattern.

PARAMETERS

ulong ulSessionID 
ID of authenticated session.
uint uSequenceID 
Sequence number.
string sIntegrity 
md5("ipaddr(sid,seq)->ListEventDescendants(sEventID,sPattern)/secret").
string sEventID 
ID of event whose children should be listed (blank for root event).
uint uGenerations
How many generations to descend. 0=all, 1=children, 2=children+grandchildren, 3=etc.
string sPattern 
Wildcarded search pattern compared against event parameter name. Empty matches all. % any string. _ any char. [a-z] char in range. [^a-z] char not in range.
bool bIncompleteOnly
Whether to omit officially observed events from the results.

RETURNS

[ SEventData {sID,sIDParent,bDependent,sName,sPath,sDetails,sParameterName,sParameterType,sParameterMinimum,sParameterMaximum,bParameterInsideMinMax} ]

string sID 
32 digit hex representing this event's globally unique id.
string sIDParent 
ID of parent event.
bool bDependent
Whether the child is dependent upon its parent.
string sName 
Event name.
string sPath 
Event path.
string sParameterName 
Name of event parameter.
string sParameterType 
Type of event parameter.
string sParameterMinimum 
Lower bound for event parameter.
string sParameterMaximum 
Upper bound for event parameter.
bool bParameterInsideMinMax 
Whether parameter value must lie within bounds or not (for event to occur).

FAULTS

Session. Event.

TEST

ListEventDescendants(null,3,"URL_RSS") according to the respective template currently returns

Views
Personal tools