Main Web API Documentation Information
|
|
Actual Page/Function Name:
|
simpleCustomerSearch |
Human Readable Name or Caption:
|
Simple Customer Search |
Page/Function Description:
|
Allows user to make basic customer search by specifying the database field to search and the value to search by. |
Page/Function Output Type:
|
API - JSON or WDDX |
Categories:
|
customer |
Extra Page/Function Notes:
|
Parameters
|
|||||||
Scope | Name | Type | Default | Description | Required | Alternates | Known Values |
Arguments | CORP_ID | Numeric | 0 | Pass in the corp id number. This is your corporation ID or your business world number. This is required and will be validated. The default is 0, but will be checked for a real number. | Yes | ||
Arguments | SEARCH_FIELD | String | Database field user wishes to limit the query by. User may use any of the following: customer_id, first_name, last_name, business_name, zip, state, email, cell_phone, home_phone, work_phone, terms, customer_tax_id, external_alternative_id, drivers_license | Yes | |||
Arguments | SEARCH_VALUE | String | The value that you wish to search the SEARCH_FIELD by. | Yes | |||
Arguments | SEARCH_FROM | Numeric | 0 | Allows user to specify on which record to begin search. Also requires the use of SEARCH_TO parameter. | No | ||
Arguments | SEARCH_TO | Numeric | 0 | Allows user to specify on which record to end search. Also requires the use of SEARCH_FROM parameter. | No |
Results
|
||||||||||||
RET_STATUS | RET_MAIN_MESSAGE | RET_SECOND_MESSAGE | Redirect Link | Description | ||||||||
ok | Successfully retrieved [number of records] from the customer database. | This assumes that everything went well and at least 1 record was found. | ||||||||||
|
||||||||||||
dataIn | Unable to get customer data requested. Missing some data. | Use your back button and try again. | This is returned if missing one or more of the required arguments (corpId, searchField, and searchValue). | |||||||||
dataIn2 | Unable to get customer data requested. Missing a valid search field. | Use your back button and try again. | This is returned if we do not have a valid search field. | |||||||||
db | Unable to connect to the customers database. Missing a list of customers that matched your search. | Use your back button and try again. | This is a catch for any errors that occur while accessing the database. |
Samples
|
|
Caption | Text |
JSON |
{"API_URL_ENCODING":"AUTO","API_CURRENT_PAYEE_ID":3,"API_CORP_KEY_ID":"PLA-0053","API_USER_PASSWORD":1234,"API_CALL_FUNCTION_NAME":"simplecustomersearch","API_INPUT_OUTPUT_TYPE":"JSON","API_USER_NAME":"demo","CORP_ID":53,"SEARCH_FIELD":"last_name","SEARCH_VALUE":"Jones"}
|