Event OpCode ETX – Retrieve Event Extra Data (UDF values)
Event OpCode ETX – Retrieve Event Extra Data (UDF values)
This opcode is used to retrieve the User-Defined field data (UDF) for the specified event. The event to retrieve UDF values for may be identified by specifying the EventKey, EventDescription, or EventCode.
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 2000 |
Y |
Should include EEX 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 belongs to. |
EventKey |
Integer |
N |
The event key to retrieve UDF data for. |
EventCode |
Varchar 255 |
N |
The event code to retrieve UDF data for. |
EventDescription |
Varchar 355 |
N |
The description of the event to retrieve UDF data for. |
Return Outputs
This API returns a result set of event UDF value information upon successful completion. The result set is structured as:
Column |
Type/Size |
---|---|
UDFNo |
Integer |
ColumnLabel |
Varchar 255 |
FormattedValue |
Varchar 2GB |
RawValue |
Varchar 7500 |
Potential Error Codes
Error |
Message |
Reason |
---|---|---|
69 |
Event Not Found! |
The function could not find a matching event entry based on the values supplied in EventKey, EventCode, and EventDescription. |