all data is live and searchable
|
Main Web API Documentation Information
|
|
|
Actual Page/Function Name:
|
getWebCustomerLogs |
|
Human Readable Name or Caption:
|
Get Web Customer Logs |
|
Page/Function Description:
|
This web service will get all of the web accessible log notes for a single customer. |
|
Page/Function Output Type:
|
API - JSON or WDDX |
|
Categories:
|
eComm,customer |
|
Extra Page/Function Notes:
|
|
|
Parameters
|
|||||||
| Scope | Name | Type | Default | Description | Required | Alternates | Known Values |
| Arguments | CORP_KEY_ID | String | Pass in the corporation key. This is a combination of 3 letters from the corporation name, a dash, and then the actual corp id number. Ex: PLA-0053, XYZ-0123. As a note, the corporation ID may be padded with zeros. This is not required, but it will be added if the number is system-generated (the numbers will be stripped off later). | Yes | |||
| Arguments | CUSTOMER_ID | Numeric | 0 | Pass in the customer id number. Pass in the customer id number. This is how the customer logs get tied to the main customer. This is the primary key from the main customer record. | Yes | ||
|
Results
|
||||||||||||
| RET_STATUS | RET_MAIN_MESSAGE | RET_SECOND_MESSAGE | Redirect Link | Description | ||||||||
| passed | success | This assumes that everything went well. | ||||||||||
|
||||||||||||
| logicProblem | Unable to connect to the database. Missing a list of customer web accessible log notes. | Use your back button and try again. | Missing a list of customer web accessible log notes. | |||||||||
|
Samples
|
|
| Caption | Text |
| JSON |
{"API_CALL_FUNCTION_NAME":"getwebcustomerlogs","CUSTOMER_ID":23169,"API_CORP_KEY_ID":"PLA-0053","API_USER_NAME":"demo","API_USER_PASSWORD":"1234","CORP_KEY_ID":"PLA-0053","API_CURRENT_PAYEE_ID":"3","API_INPUT_OUTPUT_TYPE":"JSON","API_URL_ENCODING":"AUTO"}
|