all data is live and searchable
|
Main Web API Documentation Information
|
|
|
Actual Page/Function Name:
|
getCustomerContactInfo |
|
Human Readable Name or Caption:
|
Get Customer Contact Info |
|
Page/Function Description:
|
This method will get the customer contact info for a single contact. |
|
Page/Function Output Type:
|
API - JSON or WDDX |
|
Categories:
|
eComm,customer |
|
Extra Page/Function Notes:
|
A customer contact is a sub of the main customers table. This could be anything from parents, children, spouses, guardians, babysitters, owners, shipping addresses, billing addresses, cosigners, managers, etc. |
|
Parameters
|
|||||||
| Scope | Name | Type | Default | Description | Required | Alternates | Known Values |
| Arguments | CONTACT_ID | Numeric | 0 | Pass in the contact id number. This is the auto id number that's assigned to the specific contact you're looking up. | Yes | ||
| 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 | CUSTOMER_ID | Numeric | 0 | Pass in the customer id number. | Yes | ||
|
Results
|
||||||||||||
| RET_STATUS | RET_MAIN_MESSAGE | RET_SECOND_MESSAGE | Redirect Link | Description | ||||||||
| ok | success | This assumes that everything went well. | ||||||||||
|
||||||||||||
| corpSettings | Missing the correct corp-wide settings. Unable to proceed. | Use your back button and try again. | This is returned if the query couldn't find the corp-wide settings (default customer name). | |||||||||
| dbZero | Unable to get the required corp-wide settings. Missing some data. | Use your back button and try again. | This is returned if there was an error in querying the corp-wide settings (default customer name). | |||||||||
| dataIn | Unable to get the [name] contact information. Missing some data. | Use your back button and try again. | This is returned if the contact id, corp id, or customer id arguments were not validated. | |||||||||
| db | Unable to connect to the database. Missing the [name] contact information. | Use your back button and try again. | This is returned if there is an error in querying address, business name, cell phone, city, contact id, email, name, etc. There are about 20 different values here. | |||||||||
| zero | Unable to find the [name] contact information requested. | Use your back button and try again. | This is returned if the address, business name, cell phone, city, contact id, email, name, etc. were not queried. | |||||||||
|
Samples
|
|
| Caption | Text |
| JSON |
{"API_CALL_FUNCTION_NAME":"getCustomerContactInfo","CUSTOMER_ID":23169,"CONTACT_ID":56844,"CORP_ID":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"}
|