OpCode K: Retrieve a User’s Registration Show Package information

This opcode is used to retrieve a user’s registration information for the specified show in the VTS system. Both attendees (default) and exhibitor users can be registered. The user must already exist. 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. Several conditions would prevent successful retrieval, such as the given show does not require registration or the user is not registered for the show.

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	Varchar 8000	Y	Additional demographic and profile information. See the section on Passing UDF Values for the description of the format of this field.

Return Outputs

This API returns a result set of profile information upon successful completion. The result set is structured:

Column	Type/Size
ShowPackageKey	Integer
PackageTitle	Varchar 80
AddOnsList	Varchar 1000
RegistrationDate	Varchar 30 in ODBC format (YYYY-MM-DD HH:MM:SS)
PaymentType	Integer (0 = Free, 1 = Online Credit Card, 2 = Check, 4 = PO/Invoice)
ReferenceCode	Varchar 128
IsUpgrade	Integer (0/1)
RegistrationOwner	Varchar 20
RegistrationSource	Varchar 20

Potential Error Codes

Error	Message	Reason
61	Show Does Not Require Registration!	There is no registration for this show.
62	User Not Found!	The user with either the specified ExternalUserID or EMailAddress could not be found.
63	User Not Registered!	The specified user is not registered for this show.