OpCode UDC: Update a UDF Definition, Creating it if it does not already exist

This opcode is used to update or create a UDF Definition in the VTS system. If found, the update process is invoked (OpCode UDU). If not found, the create process (OpCode UDI) is invoked.

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 UDC 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.
Souce	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.
UDFGroupKey	Integer	-	The identifier for the UDF Group to create this UDF Definition with.
UDFGroupDescription	Varchar 40	-	The description for the UDF Group to create this UDF Definition with. This is used when the UDFGroupKey is not included
UDFDefKey	Integer	-	The identifier for this UDF Definition.
UDFDefUDFNo	Integer	N	Unique UDF number by Source in your tenant. If zero (0), uses 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.
UDFDefColumnLabel	Varchar 255	N	Label for the UDF Definition. Defaults to UDFDefDescription.
UDFDefDataType	Integer	N	Zero (0) for string, one (1) for Number, two (2) for Integer, three (3) for Date, four (4) for Logical. Defaults to 0 (string).
UDFDefMaxChars	Integer	N	Maximum number of characters for string data type. Defaults to zero (0).
UDFDefEntryType	Integer	N	One (1) for Entry Field, two (2) for Text Area, four (4) for Checkbox, eight (8) for Radio Buttons, 32 for Drop Down, 64 for Look Up, 128 for Multi-select Checkbox. Defaults to one (1) (Entry Field)
UDFDefIncludePopupWidget	Integer	N	Defaults to zero (0)
UDFDefRequired	Integer	N	Defaults to zero (0)
UDFDefDisplayOnly	Integer	N	Defaults to zero (0)
UDFDefOneTimeEntryOnly	Integer	N	Defaults to zero (0)
UDFDefActive	Integer	N	Defaults to one (1)
UDFDefAllowRecipientEdit	Integer	N	Defaults to zero (0)
UDFDefSeqNo	Integer	N	Defaults to zero (0)

Return Outputs

This API returns the VTS UDF Definition Key that was created or updated.

Examples below depict a UDF Definition that did not exist and were created.

Text

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

## OpCode=UDI Status=0 Message=OK

UDFDefKey

123456

HTTP Urlencoded

APICallResult=0&APICallDiagnostic=OK&OpCodesProcessed=1&OpCodesInError=0&OpCode=UDI&Status=0&Message=OK&UDFDefKey=123456

XML

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

</ResultRow>

</OpCodeResult>

</APIResults>

JSON

{"APIResults":{"APICallResult":"0","APICallDiagnostic":"OK","OpCodesProcessed":"1","OpCodesInError":"0","OpCodeResults":[{"OpCode":"UDI","Status":"0","Message":"OK","Results":[{"UDFDefKey":123456}]}]}}

Potential Error Codes

Error	Message	Reason
20	Grouping not found!	The UDF Group defined by the UDFGroupKey and UDFGroupDescription was not found.
21	Description is blank!	UDFDescription is required and must be non blank.
22	Description already exists!	UDFDescription must be unique by Source in your tenant.
23	Invalid DataType Specified!	UDFDefDataType must be between 0 and 4 inclusive.
24	Invalid EntryType Specified!	UDFDefEntryType must be in the list of 1,2,4,8,32,64,128.
25	UDFDef not found!	UDFDefKey or UDFDefDescription must be for a valid UDF for the Source in your tenant.