OpCode M: Add AddOn Items To The Registration For The Specified User

OpCode M: Add AddOn Items to the Registration for the specified User

This opcode is used to add AddOn Items to the registration for the specified user. 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. The AddOn items to add must be specified by AddOnItemKey, with multiple entries separated by commas (,). AddOn items to be added must be members of the registration package the user is currently registered for. Also, AddOns that refer to other packages may not be specified.

Example: AddOnsChangeList=9985,10342

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	-	The show identifier to add AddOns from.
AddOnsChangeList	Varchar 8000	-	List of AddOn item keys to add to the registration for this user. Multiple entries are delimited by a comma.

Return Outputs

This API returns the status message OK upon successful completion, as well as the AddOnsAdded count of the number of AddOns added to the registration for this user.

Text

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

## OpCode=M Status=0 Message=OK

AddOnsAdded

HTTP URL-encoded

APICallResult=0&APICallDiagnostic=OK&OpCodesProcessed=1&OpCodesInError=0&OpCode=M&Status=0&Message=OK&AddOnsAdded=3

XML

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

</ResultRow>

</OpCodeResult>

</APIResults>

Potential Error Codes

Error	Message	Reason
71	User Not Found!	The user with either the specified ExternalUserID or EMailAddress could not be found.
72	User Not Registered!	The specified user is not registered for the show specified by ShowKey.