ESS Dequeue API
This ILE API wraps the ESS Dequeue Web Service. See its documentation for a further explanation of the input and output parameters, as well as the possible error conditions.
API Name: OTSDQ
Parameter Interface:
|
Parameter
|
Direction
|
Type
|
Length
|
Precision
|
Description
|
|---|---|---|---|---|---|
|
Subscriber ID |
Input |
Decimal |
9 |
0 |
|
|
Block Count In |
Input |
Decimal |
3 |
0 |
|
|
Transaction ID |
Input |
Decimal |
9 |
0 |
|
|
Format |
Input |
Character |
1 |
n/a |
The format you would like your data returned in. |
|
Block Count Out |
Output |
Decimal |
3 |
0 |
The number of unique transactions that were returned. |
|
Transaction Data |
Output |
Character |
65535 |
n/a |
See ESS TransactionBlock, the Transactions item. |
|
Output |
Decimal |
3 |
0 |
Error Category, if any |
|
|
Output |
Decimal |
5 |
0 |
Error Code, if any |
|
|
Output |
Character |
150 varying |
n/a |
Error description, if any |
An error category of 0 means that the dequeue was successful. Error category 0 does not necessarily ensure that there was any data to be dequeued, just that there was no errors.