OpCode UGU: Update A UDF Group

This opcode is used to update a UDF Group’s information in the VTS system. The Description must be unique and not already be used by another UDF Group for this tenant for this source.

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 UGU 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.
UDFGroupDescription	Varchar 40	N	The unique description for this group.
UDFGroupDisplayOrder	Integer	N	The display order of this group.
UDFGroupKey	Integer	Y	UDFGroupKey that identifies the entry to update.

Return Outputs

This API returns the VTS UDF Group Key.

Text

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

## OpCode=UGU Status=0 Message=OK

UDFGroupKey

123456

HTTP URL-encoded

APICallResult=0&APICallDiagnostic=OK&OpCodesProcessed=1&OpCodesInError=0&OpCode=UGU&Status=0&Message=OK&UDFGroupKey=123456

XML

</ResultRow>

</OpCodeResult>

</APIResults>

JSON

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

Potential Error Codes

Error	Message	Reason
11	Description already exists!	The value passed in UDFGroupDescription already exists and is associated with another UDF Group.
12	Grouping not found!	The record identified by UDFGrouopKey is not found.