OpCode UPL: List UDF Definition

This opcode is used to list the UDF picklists 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 UPL 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.
UDFDefKey	Integer	-	The identifier for this UDF Definition.
UDFDefUDFNo	Integer	N	Unique UDF number by Source in your tenant. If zero (0), use the next available number.
UDFDefDescription	Varchar 80	-	Unique UDF description by Source in your tenant. Used to lookup this UDF Definition when the UDFDefKey is invalid.

Return Outputs

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

The result set is structured as follows:

Column	Type/Size
UDFPickListKey	Integer
SeqNo	Integer
UDFValue	Varchar 8000
Position	Integer
ExternalKey	Varchar 32

Potential Error Codes

There are no potential error codes for this API call.