get_daily_batch_status_m
Summary
| API Name | get_daily_batch_status_m |
|---|---|
| Class | system_services_m |
| Update Version | 3.5 |
Description
Returns a string representing the current status of the Net Terms/Statement Status Mgr batch job for the given client and date.
Inputs
| Name | Type | Length | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||
| auth_key | string | 32 | Yes |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
||||||
| batch_date | string | 10 | Yes |
The (virtual) system date to be examined for current operational status of its daily batch jobs. |
||||||
| include_all_batches | string | 2 | No |
Return all batch process status for the day. If include_all_batch is true and batch_id is given, only supplied batch_id details will be returned. Allowed values:
|
||||||
| batch_process_id | long | 2 | No |
Valid Aria supported batch Id |
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |
|
| status | string | No |
Note: This field is deprecated. Aria no longer supports status. |
|
| batch_process_detail | object | No |
batch_process_detail fields
| Name | Type | Length | Required | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| batch_process_id | long | No |
Aria supported Batch process id |
|||||||||||||||||
| batch_process_name | string | No |
Name associated to the Batch process id |
|||||||||||||||||
| batch_process_status | string | No |
An upper-case string, from a list of allowable values, representing the current status of the daily batch process for the given input client and batch date and batch id. Allowed values:
|