ESS High Volume Dequeue API
This ILE API wraps the ESS High Volume Dequeue web service and dequeues a chunk of ESS transactions for the given subscriber while acknowledging previously dequeued transactions (if any). The dequeued transactions are then converted from base64 to EBCDIC and then parsed from XML to their fixed format equivalents before being individually stored as individual records in the PIT IITRAN transaction table.
This API detects "Macro Template Change Notification" (T.2.09.0) transaction types provided the customer has optionally subscribed to the transaction type. These transaction types indicate additions or changes were made to specific customer macro template definitions. Upon receipt of this transaction type, a web service will automatically be called to retrieve the related macro's most current template definitions, which are then stored locally in the PIT macro template database. In addition, an array containing the direction and number of each changed macro (as identified via receipt of T.2.09.0 transaction types) will be returned to the caller for informational purposes.
.
API Name: IIDEQUEUE
Parameter Interface:
|
Parameter
|
Direction
|
Type
|
Length
|
Precision
|
Description
|
|---|---|---|---|---|---|
|
Subscriber ID |
Input |
Decimal |
9 |
0 |
|
|
In (ACK) Transaction ID |
Input |
Decimal |
17 |
0 |
|
|
Out Transaction ID |
Output |
Decimal |
17 |
0 |
Highest transaction ID received in the just-dequeued block of transactions (if any). Use this as the input (ACK) transaction ID for the next call to this API. |
|
Block Count Out |
Output |
Decimal |
9 |
0 |
The number of transactions that were just dequeued in the current call. |
|
Out Macro List Block |
Output |
Character |
400 |
n/a |
A block containing a fixed format list of macros for which template change notification transactions (T.2.09.0) were dequeued in the current call. The generic block overlays a list with the following format: |
|
Out Status |
Output |
Character |
1 |
n/a |
General return status, where 0 = Success, 1 = Failure |
|
Out Reason Code |
Output |
Character |
4 |
n/a |
Specific status reason code, where 0000 = No error, 0010 = Unexpected XML format encountered |