Web Service API Calls

Last updated
Save as PDF

Overview

You can track the history of API calls made to Aria by following the steps below.

Search the Web Service API Audit Log

Getting Here: Configuration > Audit Logs > Web Service API

Enter information for any of the fields to search by that parameter.
- Request Date: The date on which the API call was made to Aria.
- API Name: The name of the API call that was made to Aria.
- Account Number: The account number of the customer whose information was updated or retrieved by the API call.
- Calling IP: The IP address from which the API call was made.
- Error Code: The error code returned by the API call.
- Session ID: An Aria-assigned unique identifier for the instance of the API call.
Click Search. Information about API calls display in the following columns:
- API Name: The name of the API call that was made to Aria.
- Request Date: The date on which the API call was made to Aria.
- Elapsed Seconds: The number of seconds that the API call took to complete its task.
- Account Number: The account number of the customer whose information was updated or retrieved by the API call.
  Note: If an alternate field to <acct_no>—such as <client_acct_id> or <user_id>—is used in an API call, and <do_write> is not false, you can still search by Account Number.
- Receipt ID: The receipt ID that was passed into the API call (if any).
- Error Code: The error code returned by the API call.
- Error Message: The error message returned by the API call.
- Calling IP: The IP address from which the API call was made.
- Caller ID: Any additional value that you chose to pass into an API call.
- Session ID: An Aria-assigned unique identifier for the instance of the API call.

Results of a Web Service API Audit Log Search

The parameters you searched for display here.
Click Refine Search to update the search parameters.
The Compare APIs button. To compare 2 to 5 APIs:
1. Check the checkbox next to each applicable API. You can check up to 5 APIs.
2. Click the Compare APIs button. A screen displays with tabs for Details, Input Parameters and Output Parameters.
  Details
  
  Input Parameters
  
  Output Parameters
3. To download the comparison as a CSV file, click Export for each tab.
To view the details of a single API call, click the API name. The details for that API display, including the same Details, Input Parameters and Output Parameters tabs.
To download the API call details as a CSV file, click Export for each tab.
You can search the log for Core API Calls related to a specific account by specifying an account number, even if the API call specified a <client_acct_id> or <user_id> (and not an <acct_no>).