all data is live and searchable
|
Main Web API Documentation Information
|
|
|
Actual Page/Function Name:
|
adilasEncoder |
|
Human Readable Name or Caption:
|
Adilas Encoder |
|
Page/Function Description:
|
Adilas Encoder |
|
Page/Function Output Type:
|
API - JSON or WDDX |
|
Categories:
|
eComm,general |
|
Extra Page/Function Notes:
|
A number of fields that are sensitive information are encrypted for storage. Use this method if you need to decode something. |
|
Parameters
|
|||||||
| Scope | Name | Type | Default | Description | Required | Alternates | Known Values |
| Arguments | INCOMING_VALUE | String | Pass in the value to encode or decode. | Yes | |||
| Arguments | MODE | String | encode | Pass in the string encode or decode. | Yes | ||
|
Results
|
||||||||||||
| RET_STATUS | RET_MAIN_MESSAGE | RET_SECOND_MESSAGE | Redirect Link | Description | ||||||||
| ok | success | This assumes that everything went well. | ||||||||||
|
||||||||||||
| dataIn | Unable to run the encoder function. Missing some data. | Use your back button and try again. | This is returned if the "incoming value" argument is less than four characters long. | |||||||||
| dataIn2 | Unable to run the encoder function. Missing a valid function mode. | Use your back button and try again. | This is returned if the "mode" argument is neither "encode" nor "decode". | |||||||||
| dataIn3 | Unable to run the encoder function. Missing a valid password to unlock the function. | Use your back button and try again. | This is returned if the "special password" argument is not the correct value. | |||||||||
| noMatch | Unable to run the encoder function. Unable to match one or more characters. | Please only use standard keys on the keyboard. This includes 0-9 (numbers), A-Z (upper case), a-z (lower case), and basic punctuation or special characters on a standard keyboard. Use your back button and try again. | This assumes that an error occurred while using the encoder function. | |||||||||
| db | Unable to run the encoder function. A logic problem occurred. | Use your back button and try again. | This is a catch for any errors that occur while running the encoding function. | |||||||||
|
Samples
|
|
| Caption | Text |
| JSON |
{"API_CALL_FUNCTION_NAME":"adilasEncoder","API_USER_PASSWORD":1234,"API_CORP_KEY_ID":"PLA-0053","API_URL_ENCODING":"AUTO","MODE":"decode","API_INPUT_OUTPUT_TYPE":"JSON","INCOMING_VALUE":"words to encode","API_CURRENT_PAYEE_ID":3,"API_USER_NAME":"demo"}
|