all data is live and searchable
|
Main Web API Documentation Information
|
|
|
Actual Page/Function Name:
|
getMainPOInfo |
|
Human Readable Name or Caption:
|
Get Main PO Info |
|
Page/Function Description:
|
This method will return the main PO info for a single purchase order. |
|
Page/Function Output Type:
|
API - JSON or WDDX |
|
Categories:
|
purchase order |
|
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. | Yes | ||
| Arguments | PO_NUMBER | Numeric | 0 | Pass in the PO number. | Yes | ||
|
Results
|
||||
| RET_STATUS | RET_MAIN_MESSAGE | RET_SECOND_MESSAGE | Redirect Link | Description |
| ok | success | This assumes that everything went well. | ||
| dataIn | Unable to grab the PO information. Missing some data. | Use your back button and try again. | This is returned if missing one or more of the following arguments: CORP_ID, PO_NUMBER. | |
| zero | Unable to find the PO you requested. | Use your back button and try again. | This is returned if no PO info could be found associated with the CORP_ID and PO_NUMBER. | |
| db | Unable to connect to the database. Missing the PO info. | 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_CALL_FUNCTION_NAME": "getMainPOInfo",
"CORP_ID": 53,
"PO_NUMBER": 123,
"API_CORP_KEY_ID": "PLA-0053",
"API_USER_NAME": "demo",
"API_USER_PASSWORD": "1234",
"API_INPUT_OUTPUT_TYPE": "JSON",
"API_CURRENT_PAYEE_ID": "3",
"API_URL_ENCODING": "AUTO"
}
|