This method will get a list of the open batches for a corp level org.
Parameters
appKey
string
A key identifying the application making the call
userKey
string
A key identifying the user making the call
corpOrgID
int
The org for which batches will be listed
Return Values
A list of gate control batch data structures containing the following fields
ID
int
The batch id
OrgID
int
The organization id
Description
string
The organization name
IsDailyBatch
bool
Indication of a Daily Running Batch
EventID
long
Event ID tied to batch
EventName
string
Event Name tied to batch
EventDate
datetime
Event Start Date
TierID
long
Tier ID tied to batch
ValidationType
int
Batch Validation Type
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/ListBatches?appkey={APPKEY}&userkey={USERKEY}&corporgid={CORPORGID}
Example XML Response
<ArrayOfGateControlBatch xmlns="http://www.agiletix.com/api">
<GateControlBatch>
<ID>2147483647</ID>
<OrgID>2147483647</OrgID>
<Description>String content</Description>
<IsDailyBatch>true</IsDailyBatch>
<EventID>9223372036854775807</EventID>
<EventName>String content</EventName>
<EventDate>1999-05-31T11:20:00</EventDate>
<TierID>9223372036854775807</TierID>
<ValidationType>2147483647</ValidationType>
</GateControlBatch>
<GateControlBatch>
<ID>2147483647</ID>
<OrgID>2147483647</OrgID>
<Description>String content</Description>
<IsDailyBatch>true</IsDailyBatch>
<EventID>9223372036854775807</EventID>
<EventName>String content</EventName>
<EventDate>1999-05-31T11:20:00</EventDate>
<TierID>9223372036854775807</TierID>
<ValidationType>2147483647</ValidationType>
</GateControlBatch>
</ArrayOfGateControlBatch>
Example JSON Response
[{
"ID":2147483647,
"OrgID":2147483647,
"Description":"String content",
"IsDailyBatch":true,
"EventID":9223372036854775807,
"EventName":"String content",
"EventDate":"\/Date(928167600000-0500)\/",
"TierID":9223372036854775807,
"ValidationType":2147483647
}]
Comments