OpCode UGD: Delete A UDF Group

This opcode is used to delete a UDF Group from the VTS system. Several conditions would prevent an exhibitor user from being deleted, such as the person being a booth contact.

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.

Return Outputs

This API returns the VTS UDF Group Key that was deleted.

Text

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

## OpCode=UGD Status=0 Message=OK

UDFGroupKey

123456

HTTP Urlencoded

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

XML

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

<APIResults APICallResult="0" APICallDiagnostic="OK" OpCodesProcessed="1" OpCodesInError="0" >

<OpCodeResult OpCode="UGD" Status="0" Message="OK" >

 <ResultRow>

  <UDFGroupKey>123456</UDFGroupKey>

 </ResultRow>

</OpCodeResult>

</APIResults>

JSON

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

Potential Error Codes