OpCode USV: UDF Source Values Listing

This opcode is used to list assigned UDF values for a given source in the VTS system. Pass UDFNo, UDFDefKey, or UDFDefDescription to only return assigned values for the specified UDF Definition.

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 USV 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 three (3) for exhibitor, four (4) for booth, five (5) for show, seven (7) for event/presentation.
UDFNo	Integer	N	UDF number to filter results for.
UDFDefKey	Integer	-	The unique description for this group.
UDFDefDescription	Varchar 80	-	Unique UDF description by Source in your tenant.

Return Outputs

This API returns a result set of UDF Value assignments upon successful completion.

The result set is structured:

Column	Type/Size
KeyVal	Integer
KeyValDesc	Varchar(500)
KeyValExternalID	Varchar(255)
ShowKey	Integer
ShowUUID	GUID
ShowExternalID	Varchar(255)
UDFNo	Integer
UDFValue	Varchar 8000
UDFPickListKey	Integer
ExternalKey	Varchar 32
DisplayValue	Varchar 8000

Potential Error Codes

Error	Message	Reason
50	Invalid Source!	The value specified for the Source was invalid.