Main Web API Documentation Information
|
|
Actual Page/Function Name:
|
getLookUpValues |
Human Readable Name or Caption:
|
Get Look Up Values |
Page/Function Description:
|
This method will grab different look up values and will pass them back to the user. |
Page/Function Output Type:
|
API - JSON or WDDX |
Categories:
|
eComm,general |
Extra Page/Function Notes:
|
This method looks up tons of different smaller tables. Please see the list below. It only requires two parameters--the TABLE_NAME and OPTIONAL_PARAM. |
Parameters
|
|||||||
Scope | Name | Type | Default | Description | Required | Alternates | Known Values |
Arguments | TABLE_NAME | String | Pass in the table name that you want data back from. Here is a list of available table names: payee_permission_categories, customer_types, customer_credit_types, customer_queue_types, contact_types, relationship_types, banks, check_types, help_files, work_shift, po_types, pay_type, receipt_types, tax_categories, account_types, time_zones, payee_type, allinv_status, payroll_status, tax_filing_status, units_of_measurement, tie_in_title_types, time_frequency_types, time_actions, invoice_status, part_categories, parts, payroll_frequency, additional_customer_types, country, corp_colors, recipe_types, and merchant_types. | Yes | |||
Arguments | OPTIONAL_PARAM | String | Pass in an optional param if needed. This is often the corp id number. It might be a best practice to always pass it in as the corp id. It shouldn't hurt anything. Example: OPTIONAL_PARAM = 53 - where 53 is the corp id number you are looking for. | No |
Results
|
||||||||||||
RET_STATUS | RET_MAIN_MESSAGE | RET_SECOND_MESSAGE | Redirect Link | Description | ||||||||
ok | success | This assumes that everything went well. | ||||||||||
|
||||||||||||
dataIn | Unable to get required page info. Missing some data." | Use your back button and try again. | This is returned if the table name argument is shorter than two characters. It assumes that the table name wasn't input. | |||||||||
db | Unable to connect to the databse. Page is missing some information. | Use your back button and try again. | This is returned if there was an error querying the requested values. |
Samples
|
|
Caption | Text |
JSON |
{"API_CALL_FUNCTION_NAME":"getLookUpValues","TABLE_NAME":"customer_types","OPTIONAL_PARAM":53,"API_CORP_KEY_ID":"PLA-0053","API_USER_NAME":"demo","API_USER_PASSWORD":"1234","API_CURRENT_PAYEE_ID":"3","API_INPUT_OUTPUT_TYPE":"JSON","API_URL_ENCODING":"AUTO"}
|