Follow

API Method - Batch Stats

This method will get statistical data for a batchid. If Terminal ID is blank this will be a single status for the whole batch. If terminal ID is specified the first stats set will be for the whole batch and the second will be for the terminal ID.
Parameters
appKey
 
string
A key identifying the application making the call
userKey
 
string
A key identifying the user making the call
orgID
 
int
The org of the gate control batch
batchID
 
int
The id of the gate control batch
terminalID
 
int
 
optional
The terminalid from which the call is made
Return Values
List of GateControlBatchStats
ValidForEntry
 
int
ValidScans
ValidMembershipWithAccess
 
int
ValidMembershipWithAccess
AlreadyRedeemed
 
int
AlreadyRedeemed
ValidMembershipBenefitUsed
 
int
ValidMembershipBenefitUsed
VoidOrCanceled
 
int
VoidOrCanceled
NotValidForEntry
 
int
NotValidForEntry
NotValidForEvent
 
int
NotValidForEvent
ValidMembershipWithoutAccess
 
int
ValidMembershipWithoutAccess
MembershipInActive
 
int
MembershipInActive
MembershipNotApproved
 
int
MembershipNotApproved
MembershipExpired
 
int
MembershipExpired
MembershipEventNotAvailable
 
int
MembershipEventNotAvailable
MembershipTicketAddFailed
 
int
MembershipTicketAddFailed
BatchClosed
 
int
BatchClosed
ErrorOccurred
 
int
ErrorOccurred
ErrorMembership
 
int
ErrorMembership
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/BatchStats?appkey={APPKEY}&userkey={USERKEY}&orgid={ORGID}&batchid={BATCHID}&terminalid={TERMINALID}
Example XML Response
<ArrayOfGateControlBatchStats xmlns="http://www.agiletix.com/api">
  <GateControlBatchStats>
    <ValidForEntry>2147483647</ValidForEntry>
    <ValidMembershipWithAccess>2147483647</ValidMembershipWithAccess>
    <AlreadyRedeemed>2147483647</AlreadyRedeemed>
    <ValidMembershipBenefitUsed>2147483647</ValidMembershipBenefitUsed>
    <VoidOrCanceled>2147483647</VoidOrCanceled>
    <NotValidForEntry>2147483647</NotValidForEntry>
    <NotValidForEvent>2147483647</NotValidForEvent>
    <ValidMembershipWithoutAccess>2147483647</ValidMembershipWithoutAccess>
    <MembershipInActive>2147483647</MembershipInActive>
    <MembershipNotApproved>2147483647</MembershipNotApproved>
    <MembershipExpired>2147483647</MembershipExpired>
    <MembershipEventNotAvailable>2147483647</MembershipEventNotAvailable>
    <MembershipTicketAddFailed>2147483647</MembershipTicketAddFailed>
    <BatchClosed>2147483647</BatchClosed>
    <ErrorOccurred>2147483647</ErrorOccurred>
    <ErrorMembership>2147483647</ErrorMembership>
  </GateControlBatchStats>
  <GateControlBatchStats>
    <ValidForEntry>2147483647</ValidForEntry>
    <ValidMembershipWithAccess>2147483647</ValidMembershipWithAccess>
    <AlreadyRedeemed>2147483647</AlreadyRedeemed>
    <ValidMembershipBenefitUsed>2147483647</ValidMembershipBenefitUsed>
    <VoidOrCanceled>2147483647</VoidOrCanceled>
    <NotValidForEntry>2147483647</NotValidForEntry>
    <NotValidForEvent>2147483647</NotValidForEvent>
    <ValidMembershipWithoutAccess>2147483647</ValidMembershipWithoutAccess>
    <MembershipInActive>2147483647</MembershipInActive>
    <MembershipNotApproved>2147483647</MembershipNotApproved>
    <MembershipExpired>2147483647</MembershipExpired>
    <MembershipEventNotAvailable>2147483647</MembershipEventNotAvailable>
    <MembershipTicketAddFailed>2147483647</MembershipTicketAddFailed>
    <BatchClosed>2147483647</BatchClosed>
    <ErrorOccurred>2147483647</ErrorOccurred>
    <ErrorMembership>2147483647</ErrorMembership>
  </GateControlBatchStats>
</ArrayOfGateControlBatchStats>
Example JSON Response
[{
	"ValidForEntry":2147483647,
	"ValidMembershipWithAccess":2147483647,
	"AlreadyRedeemed":2147483647,
	"ValidMembershipBenefitUsed":2147483647,
	"VoidOrCanceled":2147483647,
	"NotValidForEntry":2147483647,
	"NotValidForEvent":2147483647,
	"ValidMembershipWithoutAccess":2147483647,
	"MembershipInActive":2147483647,
	"MembershipNotApproved":2147483647,
	"MembershipExpired":2147483647,
	"MembershipEventNotAvailable":2147483647,
	"MembershipTicketAddFailed":2147483647,
	"BatchClosed":2147483647,
	"ErrorOccurred":2147483647,
	"ErrorMembership":2147483647
}]
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments