BoothUDF Node
BoothUDF Node
This node contains booth-level user-defined fields defined for the tenant. These nodes are contained within a BoothUDFs container node.
Example:
<BoothUDF UDFDefKey="18" Description="Product Information" ColumnLabel="Prod. Info" DataType="4" EntryType="4" MaxChars="0" Required="1" Active="1" AllowRecipientEdit="1" />
Calling the API
The API is called via a secure HTTPS request. This HTTPS request may be a GET or POST operation. 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 call :https://api.onlinexperiences.com/scripts/Server.nxp?LASCmd=AI:4;F:APIUTILS!50565&APIUserAuthCode={YourAuthCode}&APIUserCredentials={YourCredentials}&ShowKey={ShowKey}&InfoTypeFilter={filter code list, in |OPTION|OPTION| format…}
Note: The format of the APAC Data Center is: https://api.apac.onlinexperiences.com.
Specific parameter ordering is unimportant, with the only restriction being that the first parameter MUST BE LASCmd=AI:4;F:APIUTILS!50565. All other parameters may appear in any sequence order.
Attribute |
Type |
Comment |
---|---|---|
UDFDefKey |
Integer |
Notified UDF key for this user-defined field. |
Description |
String |
Description of this user-defined field. |
ColumnLabel |
String |
Column label used when displaying this user-defined field. |
DataType |
Integer |
0 – String, 1 – number, 2 – integer, 3 – date, 4 – logical |
EntryType |
Integer |
1 – entry field, 2 – textarea, 4 – checkbox, 8 – radio buttons, 32 – dropdown list, 64 – lookup, 128 – multi-select checkboxes. |
MaxChars |
Integer |
The maximum number of characters for text input. |
Required |
Flag (0/1) |
Flag indicating whether entry of this field is required. |
Active |
Flag (0/1) |
Flag indicating whether this field is active. |
AllowRecipientEdit |
Flag (0/1) |
Flag indicating whether this field is exposed to users for entry. |