Event Track OpCode ETM: List the Event Members for an Event Track
Event Track OpCode ETM: List the Event Members for an Event Track
This opcode is used to list the event members for the specified Event Track entry in the specified show. Tracks are also referred to as Packages. The Event Track to list members for may be identified either by specifying the EventPackageKey or the EventPackageDescription.
Calling the API
The API is called via a secure HTTPS request. This HTTPS request may be a GET or POST operation (except for file uploading which requires a multi-part form post). Each request must supply the authentication credentials assigned to the caller by Notified. Only requests with valid credentials will be processed. These credentials identify the caller and provide access only to a specific customer area.
The format of the API call is: https://api.onlinexperiences.com/scripts/Server.nxp?LASCmd=AI:4;F:APIUTILS!50540&APIUserAuthCode={YourAuthCode}&APIUserCredentials={YourCredentials}&OpCodeList={Opcode[OpCode[…]]}&OutputFormat={X|H|T(default)}&ShowKey={ShowKey}&{Additional, opcode-specific parameters in name=value format…}
Specific parameter ordering is unimportant, with the only restriction being that the first parameter MUST BE LASCmd=AI:4;F:APIUTILS!50540. All other parameters may appear in any sequence order.
API Parameter |
Type/Size |
Req. |
Comment |
---|---|---|---|
APIUserAuthCode |
Varchar 80 |
Y |
Your API authorization code as supplied by Notified. |
APIUserCredentials |
Varchar 80 |
Y |
Your API user credentials as supplied by Notified. |
OpCodeList |
Varchar 20 |
Y |
Should include ETM to invoke this function. |
OutputFormat |
Char 1 |
N |
T for text, H for HTTP URL-encoded, or X for XML. Defaults to T. |
ShowKey |
Integer |
Y |
The ShowKey that the Event Track belongs to. |
EventPackageKey |
Integer |
N |
The key value of the track to update. |
EventPackageDescription |
Varchar 255 |
N |
The description of this track. |
EventTypeFilter |
Integer |
N |
Specify 0 for live events, 1 for on-demand events, or 2 for both (default). |
ActiveFilter |
Integer |
N |
Specify 0 for inactive events, 1 for active events, or 2 for both (default). |
Return Outputs
This API returns a result set of member event information upon successful completion. The result set is structured as follows:
Column |
Type/Size |
---|---|
EventKey |
Integer |
Description |
Varchar 355 |
EventCode |
Varchar 255 |
Abstract |
Varchar 2GB |
EventType |
Varchar 128 |
RuntimeDuration |
Varchar 40 |
EarlyEntranceMinutes |
Integer |
EventGrouping |
Varchar 50 |
IconImage |
Varchar 255 |
RequiresRegistration |
Bit (0/1) |
Active |
Bit (0/1) |
LaunchNewWindow |
Bit (0/1) |
IsOnDemand |
Bit (0/1) |
NewWindowWidth |
Integer |
NewWindowHeight |
Integer |
BoothKey |
Integer |
BoothTitle |
Varchar 128 |
CustomSortOrder |
Integer |
ExitAction |
Integer |
ExitData |
Varchar 1000 |
ExitActionTarget |
Varchar 100 |
SubjectCategory |
Integer |
Category |
Integer |
CreatedOnDate |
Datetime |
OnDemandEventKey |
Integer |
MaxConcurrentViewers |
Integer |
Keywords |
Varchar 400 |
LocaleID |
Integer |
FromDateTime |
Datetime |
ToDateTime |
Datetime |
Potential Error Codes
Error |
Message |
Reason |
---|---|---|
33 |
Event Track Does Not Exist! |
The function could not find a matching track entry based on the values supplied in EventPackageKey and EventTrackDescription. |