This method will authenticate a user for scanning / gate control operations. Method should be called once per session to validate users permissions and get the needed UserKey and TerminalID values.
Parameters
appKey
string
A key identifying the application making the call
username
string
The username of the user making the call
password
string
The password of the user making the call
domain
string
The domain to authenticate to
deviceID
string
A unique ID of the device being used
terminalKey
string
optional
A unique key for a terminal
Return Values
An auth status data structure containing the following fields
UserAuthenticated
bool
The current onsales status for the event
Domain
string
Domain Authenticated To
RegionalOrgID
string
The regional org id of the user
CorpOrgID
int
The corp org id of the user
UserKey
string
The API Key for the user that authenticated
TerminalID
int
The terminal id that corresponds to the device id
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
Example Request
https://prod1.agileticketing.net/api/GateControl.svc/xml/AuthenticateUser?appkey={APPKEY}&username={USERNAME}&password={PASSWORD}&domain={DOMAIN}&deviceid={DEVICEID}&termkey={TERMKEY}
Example XML Response
<AuthStatus xmlns="http://www.agiletix.com/api"> <UserAuthenticated>true</UserAuthenticated> <Domain>String content</Domain> <RegionalOrgID>2147483647</RegionalOrgID> <CorpOrgID>2147483647</CorpOrgID> <UserKey>String content</UserKey> <TerminalID>2147483647</TerminalID> </AuthStatus>
Example JSON Response
{
"UserAuthenticated":true,
"Domain":"String content",
"RegionalOrgID":2147483647,
"CorpOrgID":2147483647,
"UserKey":"String content",
"TerminalID":2147483647
}
Comments