OpCode UDL: List UDF Definitions

This opcode is used to list the UDF definitions in the VTS system.

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 is: https://api.onlinexperiences.com/scripts/Server.nxp?LASCmd=AI:4;F:APIUTILS!50507&APIUserAuthCode={YourAuthCode}&APIUserCredentials={YourCredentials}&OpCodeList={Opcode[OpCode[…]]}&OutputFormat={J|X|H|T(default)} &{Additional, opcode-specific parameters in name=value 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!50507. All other parameters may appear in any sequence.

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 UGD to invoke this function.
OutputFormat	Char 1	N	T for text, H for HTTP URL-encoded, X for XML, J for JSON. Defaults to T.
Source	Integer	Y	Pass one (1) for attendee, two (2) for documents, three (3) for exhibitor, four (4) for booth, five (5) for show, seven (7) for event/presentation.

Return Outputs

This API returns a result set of UDF Definitions information upon successful completion.

The result set is structured as:

Column	Type/Size
UDFDefKey	Integer
UDFNo	Integer
UDFGroupKey	Integer
GroupDescription	Varchar 40
GroupDisplayOrder	Integer
Description	Varchar 80
ColumnLabel	Varchar 255
DataType	Integer
DataTypeDesc	Varchar 8
MaxChars	Integer
EntryType	Integer
EntryTypeDesc	Varchar 16
IncludePopupWidget	Integer
Required	Integer
DisplayOnly	Integer
OneTimeEntryOnly	Integer
Active	Integer
AllowRecipientEdit	Integer
SeqNo	Integer

Potential Error Codes

There are no potential error codes for this API call.