get_acct_comments_m
Returns the comments associated with a particular account for a specified date range.
For error messages generated by this API, see get_acct_comments_m Error Messages.
Input Arguments
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. | ||||||
![]() |
acct_no | long | 22 | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. | ||||||
OR | ||||||||||
![]() |
client_acct_id | string | 50 | Client-defined account identifier. | ||||||
![]() |
date_range_start | string | 10 | The start-date of the given date range. | ||||||
![]() |
date_range_end | string | 10 | The end-date of the given date range | ||||||
do_url_encoding | string | 5 |
A boolean value that informs the API method to do MIME Encoding of the data to be returned (if any). Allowable values for do_url_encoding:
|
|||||||
filter_application_id | string | 300 | When provided, the search shall perform an exact equals to the input that is provided to fetch the relevant application ID and application date. | |||||||
alt_caller_id | string | 30 | Person or process that submitted the API call. This can be someone's user ID, or the name of an application. | |||||||
optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | ||||||||
string | 100 | Name of the field you want to associate with this API call. | ||||||||
string | 100 | Corresponding value of the field you want to associate with this API call. |
Output Arguments
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. |
acct_comments | hash | |
string | User/Author of the comment. | |
string | Time/date stamp the comment was created. The output format is yyyy-mm-dd hh24:mi:ss | |
string | The body of the comment. | |
string | The application identifier in which the API/UI is being used.(Example: Sales Force). | |
string | The application date/timestamp, when the application is called from UI/API. | |
long | A unique identifier per comment to identify possible duplicate entries. |