OpCode UGC: Update A UDF Group, Creating it if it does not exist

This opcode is used to update or create a UDF Group in the VTS system. If found, the update process is invoked (OpCode UGU). If not found, the create process (OpCode UGI) 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 UGC 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.
UDFGroupDescription	Varchar 40	N	The unique description for this group.
UDFGroupDisplayOrder	Integer	N	The display order of this group.
UDFGroupKey	Integer	Y	The UDFGroupKey identifies the entry to update.

Return Outputs

This API returns the VTS UDF Group Key. If the user existed and was updated, the OpCode of UGU is returned. If the user did not exist and was created, the OpCode of UGI is returned. Examples below depict a user that did not exist and was created.

Text

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

## OpCode=UGI Status=0 Message=OK

UDFGroupKey

123456

HTTP Urlencoded

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

XML

</ResultRow>

</OpCodeResult>

</APIResults>

JSON

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

Potential Error Codes

Error	Message	Reason
10	Description is blank!	UDFGroupDescription is a required field and must contain a value.
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.