eoSetAlias

Action Parameter eoSetAlias
Purpose To provide a mechanism to record a consumer, who is not a direct eCore user, as the participant on an event.
Description An alias is created to record the 'persona' of a user who has been authenticated through the calling application as the participant on a given event. This facilitates a single sign-on for users who are not necessarily direct eCore users. When an alias is set, until the calling application either logs out or clears the alias (eoClearAlias), all recorded events will reflect the name of the alias, rather than the name of the logged in user. If the given alias name (alias) has been used before, the properties of the alias will remembered and applied unless overridden by the current call to eoSetAlias.
Type Granular
Preconditions The eoLogin action has been successfully completed.
Implementation Notes The eoSetAlias request parameters are only required on the FIRST call of eoSetAlias - parameters are maintained within eCore on all subsequent calls until eoClearAlias or eoLogout is requested.
To update the parameters on an existing alias user, submit the "eoSetAlias" call again with updated parameter request data. The updated parameters will be applied and retained on subsequent calls until eoClearAlias or eoLogout is requested.

Parameters

Required Parameter Value Description
required userEmail User's email address
required userFirstName
User's first name
required userLastName
User's last name
ipAddress User's IP address
userSuffix
User's suffix
userMiddleName
User's middle name
userAddress1
User's street address (line 1)
userAddress2
User's street address (line 2)
userAddress3
User's street address (line 3)
userCity
User's city
userState
User's state
userZip
User's zip code
userCountry
User's country
userPhone
User's phone number
userAltPhone
User's alternate phone number
userFax
User's fax number

Note 1: The parameters are required during the first call of aliasUser. For subsequent calls, the parameters are optional.

Response

We recommend using the most recent version of FireFox while testing API calls via your web browser. Microsoft Edge and Google Chrome require 3rd party XML extensions to display the XML response natively in your browser.