This method will validate a barcode against a live scan batch.
Parameters
appKey
string
A key identifying the application making the call
userKey
string
A key identifying the user making the call
terminalID
int
The terminalid from which the call is made
orgID
int
The org of the gate control batch
batchID
int
The id of the gate control batch
eventID
long
The event id attached to the batch
tierID
long
The tier id attached to the batch
barcode
string
The barcode to validate
scanDateTime
datetime
optional
The date and time that the scan was recorded. Used when uploading a scan at a later time.
Return Values
A gate control result data structure containing the following fields
IsValid
bool
IsValid
Code
int
Code
ShortMessage
string
ShortMessage
Message
string
Message
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/GateControl.svc/xml/ValidateBarcode?appkey={APPKEY}&userkey={USERKEY}&terminalid={TERMINALID}&orgid={ORGID}&batchid={BATCHID}&eventid={EVENTID}&tierid={TIERID}&barcode={BARCODE}
Example XML Response
<GateControlResult xmlns="http://www.agiletix.com/api"> <IsValid>true</IsValid> <Code>2147483647</Code> <ShortMessage>String content</ShortMessage> <Message>String content</Message> </GateControlResult>
Example JSON Response
{
"IsValid":true,
"Code":2147483647,
"ShortMessage":"String content",
"Message":"String content"
}
Comments