OpCode UVS: Save UDF Values

This opcode is used to save UDF values in the VTS system. One of UDFDefKey and UDFDefDescription must refer to a valid 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 UVS 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 unique description for this group.
UDFDefDescription	Varchar 80	-	Unique UDF description by Source in your tenant.
UDFPickListKey	Integer	-	Unique UDF Picklist key. One of UDFPickListKey or UDFPickListExternalKey must refer to a valid picklist.
UDFPickListExternalKey	Varchar 32	-	External unique key. One of UDFPickListKey or UDFPickListExternalKey must refer to a valid picklist.
UDFPickListUDFValue	Varchar 8000		Value of the pick list or description of the multi-select picklist.
ShowKey	Integer
KeyVal	Integer		Refers to a VTS record that matches the Source
LookupKeyValByExternalID	Integer		Use one (1) to look up the record by KeyValExternalID. Use zero (0) to lookup by KeyVal. Defaults to zero (0).
KeyValExternalID	Varchar 255		Refers to a VTS record that matches the Source

Return Outputs

This API returns the VTS UDF Key Val and UDF number that was saved.

Text

### APICallResult=0 APICallDiagnostic=OK OpCodesProcessed=1 OpCodesInError=0

## OpCode=UVS Status=0 Message=OK

KeyVal,UDFNo

123456,1000

HTTP Urlencoded

APICallResult=0&APICallDiagnostic=OK&OpCodesProcessed=1&OpCodesInError=0&OpCode=UVS&Status=0&Message=OK&KeyVal=123456&UDFNo=1000

XML

<?xml version="1.0" encoding="utf-8" ?>

</ResultRow>

</OpCodeResult>

</APIResults>

JSON

{"APIResults":{"APICallResult":"0","APICallDiagnostic":"OK","OpCodesProcessed":"1","OpCodesInError":"0","OpCodeResults":[{"OpCode":"UVS","Status":"0","Message":"OK","Results":[{"KeyVal":123456, "UDFNo":1000}]}]}}

Potential Error Codes

Error	Message	Reason
40	KeyVal not found!	The KeyVal must match a valid record for the Source in your tenant.