Main Web API Documentation Information
|
|
Actual Page/Function Name:
|
getGeneralLookupValues |
Human Readable Name or Caption:
|
Get General Lookup Values |
Page/Function Description:
|
This method will help to get a number of eCommerce look-up values. |
Page/Function Output Type:
|
API - JSON or WDDX |
Categories:
|
eComm,stock/unit,general |
Extra Page/Function Notes:
|
This returns data like inventory types, makes, sub inventory types, and locations. The location lookup is one of the most common uses. |
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 |
Results
|
||||||||||||||||||||||||||||
RET_STATUS | RET_MAIN_MESSAGE | RET_SECOND_MESSAGE | Redirect Link | Description | ||||||||||||||||||||||||
ok | success | This assumes that everything went well. | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
zeroInventoryTypes | Sorry, unable to find any inventory types associated with the corporation requested. | Use your back button and try again. | This is returned if there are no records returned associated with the corp id requested. | |||||||||||||||||||||||||
logicProblem | Unable to connect to the database. Missing lookup values for the search page. | Use your back button and try again. | This is a catch for any errors that occur while querying the database. |
Samples
|
|
Caption | Text |
JSON |
{"API_CALL_FUNCTION_NAME":"getGeneralLookupValues","CORP_KEY_ID":"PLA-0053","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"}
|