OpCode G: Get User Profile information

This opcode is used to retrieve a user’s profile information from the VTS system. Both attendees (default) and exhibitor users can be queried. 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	N	Your internal identifier for this person. This value must be unique for each person.
EMailAddress	Varchar 255	Y	The person’s email address.
UDFValues	Varchar 8000	N	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
ShowUserKey	Integer
Name	Varchar 80
CompanyName	Varchar 80
EMailAddress	Varchar 255
Phone	Varchar 80
Phone2	Varchar 80
LoginID	Varchar 80
Password	Varchar 80
EmoticonImage	Varchar 255
UserProfile	Varchar 3500
Message	Varchar 3500
TimeZoneInfoKey	Integer
Active	Bit (0/1)
UserType	Bit (0/1)
AttendeeType	Varchar 80
Exhibitor	Varchar 80
ExhibitorUserType	Varchar 80
Address	Varchar 300
City	Varchar 100
StateProv	Varchar 100
Country	Varchar 100
PostalCode	Varchar 30
SkypeID	Varchar 80
AOLIMID	Varchar 80
YahooIMID	Varchar 80
MSNIMID	Varchar 80
TwitterID	Varchar 15
JobTitle	Varchar 100
LocaleID	Integer
SubHostGroupingList	Varchar
(OPTIONALLY, UDF / SHOW SURVEY COLUMN VALUES FOLLOW…)	Variable, based on UDF definition

Potential Error Codes

Error	Message	Reason
11	A User With This External ID Already Exists!	The value passed in ExternalUserID already exists and is associated with another person.