|
Main Web API Documentation Information
|
|
|
Actual Page/Function Name:
|
adilasDemoAPI |
|
Human Readable Name or Caption:
|
Adilas Demo API |
|
Page/Function Description:
|
This method is a simple demo API connection that just does simple math. |
|
Page/Function Output Type:
|
API - JSON or WDDX |
|
Categories:
|
demo |
|
Extra Page/Function Notes:
|
|
|
Parameters
|
|||||||
| Scope | Name | Type | Default | Description | Required | Alternates | Known Values |
| Arguments | VALUE_1 | Numeric | 1 | Pass in the test number 1. | Yes | ||
| Arguments | VALUE_2 | Numeric | 1 | Pass in the test number 2. | Yes | ||
| Arguments | OPERATION | String | Pass in the operation string. Looking for a +, -, *, or /. | Yes | |||
|
Results
|
||||
| RET_STATUS | RET_MAIN_MESSAGE | RET_SECOND_MESSAGE | Redirect Link | Description |
| ok | success | This assumes that everything went well. | ||
| dataIn | Unable to do the demo math. Missing a valid operation string. See note below. | Valid operator values are: a + (plus sign), a - (minus sign), a / (divid sign), or an * (times sign). Use your back button and try again. | Missing a valid operation string. | |
| dataIn2 | Missing a valid operator value. See note below. | Valid operator values are: a + (plus sign), a - (minus sign), a / (divid sign), or an * (times sign).<br />Use your back button and try again. | Invalid operator value. | |
| divisionByZero | Check value 2. We can not divide by zero (0). | Use your back button and try again. | Value_2 cannot be 0. | |
| math | Unable to run the math that you requested. An error occurred while trying to calculate the values passed in. | Use your back button and try again. | A math error resulted. | |
|
Samples
|
|
| Caption | Text |
| JSON |
{"API_URL_ENCODING":"AUTO","API_CURRENT_PAYEE_ID":3,"API_CORP_KEY_ID":"Pla-0053","API_USER_PASSWORD":1234,"VALUE_1":1,"VALUE_2":1,"OPERATION":"+","API_CALL_FUNCTION_NAME":"adilasDemoAPI","API_INPUT_OUTPUT_TYPE":"JSON","API_USER_NAME":"demo2"}
|