OpCode Z: Get Registration Unique ID

This opcode is used to retrieve a registration identifier for a specific user from a show in the VTS system. Both attendees and exhibitor users can be retrieved. The user must already exist, the show must already exist, and the user must be registered for the show. If LookupByExternalUserID is specified as one (1), then the user is located based on the ExternalUserID value. Otherwise, the user is located based on EMailAddress.

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!50500&APIUserAuthCode={YourAuthCode}&APIUserCredentials={YourCredentials}&OpCodeList={Opcode[OpCode[…]]}&OutputFormat={X|H|T(default)}&LookupByExternalUserID={0(default)|1}&{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!50500. 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 I to invoke this function.
OutputFormat	Char 1	N	T for text, H for HTTP URL-encoded, or X for XML. Defaults to T.
LookupByExternalUserID	Bit (0/1)	N	Pass one (1) to look up this person by the supplied ExternalUserID (your internal identifier).
ExternalUserID	Varchar 255	-	Your internal identifier for this person. This value must be unique for each person.
EMailAddress	Varchar 255	-	The person’s email address.
ShowKey	Integer	Y	The show identifier to unregister the user from.

Return Outputs

This API returns the status message OK upon successful completion, and also the value for UniqueUserID.

Text

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

## OpCode=Z Status=0 Message=OK

UniqueUserID

F5CF326F-6117-40C7-96AE-43F12FCC1D65

HTTP URL-encoded

APICallResult=0&APICallDiagnostic=OK&OpCodesProcessed=1&OpCodesInError=0&OpCode=I&Status=0&Message=OK&UniqueUserID=F5CF326F-6117-40C7-96AE-43F12FCC1D65

XML

</ResultRow>

</OpCodeResult>

</APIResults>

After retrieving the UniqueUserID value, the redirect URL can be constructed as follows:

https://onlinexperiences.com/launch/UUID.htm?ShowKey={value1}&LocaleID={value2}&DisableSystemCheck=1&UUID={value3}

The tag {value3} is replaced with the UniqueUserID value returned from the API call. Value1 will be the ShowKey number, and Value2 will be the language/locale id for this user. See the table in the Locale Reference section for valid values, default is 1033.

Potential Error Codes

Error	Message	Reason
61	Show Does Not Require Registration!	The specified show is not configured for registering users.
62	User Not Found!	The user with either the specified ExternalUserID or EMailAddress could not be found.
82	User Not Registered!	The specified user is not currently registered for the specified show.