This method will authenticate a customer based on email address and password. If the customer has any memberships they will be returned along with the customer information.
Parameters
appKey
string
A key identifying the application making the call
userKey
string
A key identifying the user making the call
corpOrgID
int
The corp organization ID
email
string
The email for the customer to authenticate
password
string
The password to use for authentication
Return Values
A customer authentication data structure with the following fields
Authenticated
bool
An indicator that the customer has authenticated
CustomerID
long
The customer ID
CustomerName
string
The name of the customer
Members
list
A list of member data structures with the following fields
MemberID
long
The member ID
MemberNumber
string
The member number
MembershipID
int
The membership program ID
MembershipExpiration
datetime
The expiration date of the membership
ValidBuyerTypes
list
A list of int values for the restricted buyer types this member has access to
Barcode
string
The barcode of the membership
MembershipProgram
string
The name of the membership program
MembershipLevel
string
The level of the membership
Errors
ApplicationKeyMissing
1000
Required parameter appkey is missing or invalid
UserCredentialsMissing
1001
Required user credentials are missing or invalid
SecurityInsufficient
1002
User security does not permit access to the requested function
RequiredParameter
1028
Required parameter is missing
CustomerNotFound
1021
Customer not found
OnlineAccountRequired
1026
An online account is required for the customer
InvalidLogin
1027
Invalid password
AuthenticationKeyInvalid
1042
Invalid authentication key
Example Request
https://prod1.agileticketing.net/api/sales.svc/json/AuthenticateEmail?appkey={APPKEY}&userkey={USERKEY}&corporgid={CORPORGID}&email={EMAIL}&password={PASSWORD}
Example JSON Response
{
"Authenticated":true,
"CustomerID":9223372036854775807,
"CustomerName":"String content",
"Members":[{
"MemberID":9223372036854775807,
"MemberNumber":"String content",
"MembershipID":2147483647,
"MembershipExpiration":"\/Date(928167600000-0500)\/",
"ValidBuyerTypes":[2147483647],
"Barcode":"String content",
"MembershipProgram":"String content",
"MembershipLevel":"String content"
}]
}
Example XML Response
<CustomerAuth xmlns="http://www.agiletix.com/api">
<Authenticated>true</Authenticated>
<CustomerID>9223372036854775807</CustomerID>
<CustomerName>String content</CustomerName>
<Members>
<Member>
<MemberID>9223372036854775807</MemberID>
<MemberNumber>String content</MemberNumber>
<MembershipID>2147483647</MembershipID>
<MembershipExpiration>1999-05-31T11:20:00</MembershipExpiration>
<ValidBuyerTypes>
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
</ValidBuyerTypes>
<Barcode>String content</Barcode>
<MembershipProgram>String content</MembershipProgram>
<MembershipLevel>String content</MembershipLevel>
</Member>
<Member>
<MemberID>9223372036854775807</MemberID>
<MemberNumber>String content</MemberNumber>
<MembershipID>2147483647</MembershipID>
<MembershipExpiration>1999-05-31T11:20:00</MembershipExpiration>
<ValidBuyerTypes>
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
</ValidBuyerTypes>
<Barcode>String content</Barcode>
<MembershipProgram>String content</MembershipProgram>
<MembershipLevel>String content</MembershipLevel>
</Member>
</Members>
</CustomerAuth>
Comments