OpCodes R and r: Register a User for a show with specified Show Package

This opcode is used to register a user for a 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 a successful registration, such as registration being full, registration closed, or the user is already registered for the show. If the opcode r (lowercase) is specified, any existing registration data is updated/reversed as necessary. Affiliate/Tracking data may be passed via the AffiliateKey and AffiliateData parameters. If AffiliateData is specified and AffiliateKey omitted, the system will look up the default Affiliate and track this registration against that one. If a default is not found, one will automatically be created. Note that Affiliate information is only tracked for new registrations. Registration updates will not record Affiliate information.

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	N	Your internal identifier for this person. This value must be unique for each person.
EMailAddress	Varchar 255	Y	The person’s email address.
ShowKey	Integer	-	Additional demographic and profile information. See the section on Passing UDF Values for the description of the format of this field.
ShowPackageKey	Integer	Y	The show package identifier that the person should be registered with.
AddOnsList	Varchar 1000	N	An optional comma-separated list of add-on item identifiers to include with the show package.
TriggerRegistrationEvents	Bit (0/1)	N	If set to one (1), then the system will process registration events such as sending email confirmations. Defaults to zero (0).
AffiliateKey	Integer	N	The key value of the Affiliate to track this registration against.
AffiliateData	Varchar 255	N	Marketing code to track this registration against.
MatchmakingOptIn	Bit (0/1)	N	Indicates the user has consented to be included in Matchmaking AI/ML services, which may be 3rd party.

Return Outputs

This API returns the status message OK upon successful completion, as well as a unique user identifier for this registration for this event.

Text

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

## OpCode=R Status=0 Message=OK

Result

OK, BB0DAED6-3528-436A-ACE2-00026A7875D4

HTTP URL-encoded

APICallResult=0&APICallDiagnostic=OK&OpCodesProcessed=1&OpCodesInError=0&OpCode=R&Status=0&Message=OK&Result=OK

XML

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

</ResultRow>

</OpCodeResult>

</APIResults>

Potential Error Codes

Error	Message	Reason
41	User Not Found!	The user with either the specified ExternalUserID or EMailAddress could not be found.
42	Show Registration Is Closed!	The current date is outside the show dates available for registration.
43	Show Registration Is Full!	The registrant limit for this show has been reached.
44	User is already registered for this show!	The user has already been registered.