Req | Field Name | Field Type | Max Length | Description |
---|---|---|---|---|
![]() |
client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. |
![]() |
auth_key | string | 32 | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
![]() |
batch_date | string | 10 | The (virtual) system date to be examined for current operational status of its daily batch jobs. |
include_all_batches | string | 2 | Returns all batch process statuses for the day. If include_all_batch is true and batch_id is given, only supplied batch_id details will be returned. | |
batch_process_id | string | 2 | Valid Aria-supported batch ID. |
Field Name | Field Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error_code | long | Aria-assigned error identifier. 0 indicates no error. | ||||||||||||||||||
error_msg | string | Description of any error that occurred. "OK" if there was no error. | ||||||||||||||||||
batch_process_detail | hash | |||||||||||||||||||
|
string | Aria-supported batch process ID associated to the client. | ||||||||||||||||||
|
string | Name associated with the batch process ID. | ||||||||||||||||||
|
string |
An upper-case string, from a list of allowable values, that represents current status of the daily batch process for the given input client, batch date, and batch ID. Allowable values for status:
|