This will end up being the documentation for the adilas mini API. We were in a hurry and did a quick copy and paste from the bottom of one of the code pages. This is not the final documentation... just a quick copy and paste. Better stuff coming soon...
URL.useCorpKeyId or FORM.corp_key_id - pass in the corp key id value - Example: USE-0053 or Adi-22
URL.aiQuickSearch or FORM.ai_quick_search_field - search string or option/prompt value
URL.mode or FORM.mode - default is json, if passed in, it will show JSON. the other JSON option is to pass in mode="" (blank). if you want to show or dump the return object, use the following two possible options: mode=dump or mode=show - both of those will show the Adobe ColdFusion dump of the object (more visual vs the raw JSON).
|
Keyword/Prompt
|
Info
|
|
customer types [filter]
|
If no filter is passed in, it will try to get all customer types. If a filter is passed in, it will try to match a part of the customer type name. Example: customer types VIP
|
Samples:
No filter
https://data0.adilas.biz/web/adilas_mini_api_calls.cfm?useCorpKeyId=USE-0053&mode=show&aiQuickSearch=customer%20types
Small filter of VIP (could be anything)
https://data0.adilas.biz/web/adilas_mini_api_calls.cfm?useCorpKeyId=USE-0053&mode=show&aiQuickSearch=customer%20types%20VIP
|
|
Keyword/Prompt
|
Info
|
|
customer lookup [filter]
|
If no filter is passed in, it will try to get all customers for a single corp inside the system. There is a limit of showing a max of 100 customer/clients at a time. If there are more customer/clients than 100, use some simple filters. They come in various varieties. Here are some examples:
customer lookup [general alpha/numeric search] - this syntax does a general search and checks the business name, the last name, and the first name field for any matches. Keep it simple.
customer lookup [-key:value pairs - multi] - this syntax looks for special -key:value pairs. There are both short and long filters - either ones work great. Here are some valid options.
-bn:[business name filter] or -business_name:[business name filter]
-fn:[first name filter] or -first_name:[first name filter]
-ln:[last name filter] or -last_name:[last name filter]
-ph:[phone filter] or -phone:[phone filter]
-em:[email filter] or -email:[email filter]
If the mini API can find a "-" and a ":" it will look for any of the sub filters. These advanced customer lookup filters may be combined in any order. Only add the ones that you want or need. If they (the special filters) are not present, the general search will be used.
|
Samples:
No filter
https://data0.adilas.biz/web/adilas_mini_api_calls.cfm?useCorpKeyId=USE-0053&mode=show&aiQuickSearch=customer%20lookup
Small filter of Sponge - say I was looking for SpongeBob (could be anything)
https://data0.adilas.biz/web/adilas_mini_api_calls.cfm?useCorpKeyId=USE-0053&mode=show&aiQuickSearch=customer%20lookup%20Sponge
-Key:Value filter of first name Bob and last name Smith
https://data0.adilas.biz/web/adilas_mini_api_calls.cfm?useCorpKeyId=Use-0053&mode=show&aiQuickSearch=customer%20lookup%20-fn:Bob%20-ln:Smith
-Key:Value filter of a phone number of 435-790-0987
https://data0.adilas.biz/web/adilas_mini_api_calls.cfm?useCorpKeyId=Use-0053&mode=show&aiQuickSearch=customer%20lookup%20-ph:435-790-0987
-Key:Value filter of an email of john@gmail.com
https://data0.adilas.biz/web/adilas_mini_api_calls.cfm?useCorpKeyId=Use-0053&mode=show&aiQuickSearch=customer%20lookup%20-em:john@gmail.com
-Key:Value filter of a business name of GPS
https://data0.adilas.biz/web/adilas_mini_api_calls.cfm?useCorpKeyId=Use-0053&mode=show&aiQuickSearch=customer%20lookup%20-bn:GPS
-Key:Value filter of for Bob Smith, using the longer filters
https://data0.adilas.biz/web/adilas_mini_api_calls.cfm?useCorpKeyId=Use-0053&mode=show&aiQuickSearch=customer%20lookup%20-first_name:Bob%20-last_name:Smith
Here are some other samples, using the longer filters
https://data0.adilas.biz/web/adilas_mini_api_calls.cfm?useCorpKeyId=Use-0053&mode=show&aiQuickSearch=customer%20lookup%20-phone:435-790-0987
https://data0.adilas.biz/web/adilas_mini_api_calls.cfm?useCorpKeyId=Use-0053&mode=show&aiQuickSearch=customer%20lookup%20-email:john@gmail.com
https://data0.adilas.biz/web/adilas_mini_api_calls.cfm?useCorpKeyId=Use-0053&mode=show&aiQuickSearch=customer%20lookup%20-business_name:GPS
|
|
Keyword/Prompt
|
Info
|
|
item categories [filter]
|
If no filter is passed in, the system will try to get all item/part categories. If a filter is passed in, the system will try to match it as best as it can. Example: item categories candy
|
Samples:
No filter
https://data0.adilas.biz/web/adilas_mini_api_calls.cfm?useCorpKeyId=USE-0053&mode=show&aiQuickSearch=item%20categories
Small general filter of candy (could be anything)
https://data0.adilas.biz/web/adilas_mini_api_calls.cfm?useCorpKeyId=USE-0053&mode=show&aiQuickSearch=item%20categories%20Candy
|
|
Keyword/Prompt
|
Info
|
|
item lookup [filter]
|
If no filter is passed in, the system will try to get all parts or items (general inventory items) in the system. There is a max of 100 items that may be shown at a time. If the general filter is used, it will try to match the part_number field in the database. Example: item lookup bit (part of the item number for bit-o-honey)
|
Samples:
No filter
https://data0.adilas.biz/web/adilas_mini_api_calls.cfm?useCorpKeyId=USE-0053&mode=show&aiQuickSearch=item%20lookup
Small general filter of bit - short for bit-o-honey (could be anything)
https://data0.adilas.biz/web/adilas_mini_api_calls.cfm?useCorpKeyId=USE-0053&mode=show&aiQuickSearch=item%20lookup%20bit
|
|
Keyword/Prompt
|
Info
|
|
vendor lookup [filter]
|
If no filter is passed in, it will try to get all vendor/payees for a single corp inside the system. There is a limit of showing a max of 100 vendor/payees at a time. If there are more vendor/payees than 100, use some simple filters. They come in various varieties. Here are some examples:
vendor lookup [general alpha/numeric search] - this syntax does a general search and checks the business name, the last name, and the first name field for any matches. Keep it simple.
vendor lookup [-key:value pairs - multi] - this syntax looks for special -key:value pairs. There are both short and long filters - either ones work great. Here are some valid options.
-bn:[business name filter] or -business_name:[business name filter]
-fn:[first name filter] or -first_name:[first name filter]
-ln:[last name filter] or -last_name:[last name filter]
-ph:[phone filter] or -phone:[phone filter]
-em:[email filter] or -email:[email filter]
If the mini API can find a "-" and a ":" it will look for any of the sub filters. These advanced vendor lookup filters may be combined in any order. Only add the ones that you want or need. If they (the special filters) are not present, the general search will be used.
|
Samples:
No filter
https://data0.adilas.biz/web/adilas_mini_api_calls.cfm?useCorpKeyId=USE-0053&mode=show&aiQuickSearch=vendor%20lookup
Small filter of XYZ - say I was looking for XYZ Wine (could be anything)
https://data0.adilas.biz/web/adilas_mini_api_calls.cfm?useCorpKeyId=USE-0053&mode=show&aiQuickSearch=vendor%20lookup%20XYZ
-Key:Value filter of a business name of Adilas Branding
https://data0.adilas.biz/web/adilas_mini_api_calls.cfm?useCorpKeyId=USE-0053&mode=show&aiQuickSearch=vendor%20lookup%20-bn:Adilas%20Branding
-Key:Value filter of a phone number of 555-5555
https://data0.adilas.biz/web/adilas_mini_api_calls.cfm?useCorpKeyId=USE-0053&mode=show&aiQuickSearch=vendor%20lookup%20-ph:555-5555
-Key:Value filter of an email of oxo_cooking@gmail.com
https://data0.adilas.biz/web/adilas_mini_api_calls.cfm?useCorpKeyId=USE-0053&mode=show&aiQuickSearch=vendor%20lookup%20-email:oxo_cooking@gmail.com
-Key:Value filter of for Suzi Sunshine, using the longer filters
https://data0.adilas.biz/web/adilas_mini_api_calls.cfm?useCorpKeyId=USE-0053&mode=show&aiQuickSearch=vendor%20lookup%20-first_name:suzi%20-last_name:Sunshine
|
|
Keyword/Prompt
|
Info
|
|
employee lookup [filter]
|
If no filter is passed in, it will try to get all employee/user/payees for a single corp inside the system. There is a limit of showing a max of 100 employee/user/payees at a time. If there are more employee/users than 100, use some simple filters. They come in various varieties. Here are some examples:
employee lookup [general alpha/numeric search] - this syntax does a general search and checks the business name, the last name, and the first name field for any matches. Keep it simple.
employee lookup [-key:value pairs - multi] - this syntax looks for special -key:value pairs. There are both short and long filters - either ones work great. Here are some valid options.
-bn:[business name filter] or -business_name:[business name filter]
-fn:[first name filter] or -first_name:[first name filter]
-ln:[last name filter] or -last_name:[last name filter]
-ph:[phone filter] or -phone:[phone filter]
-em:[email filter] or -email:[email filter]
If the mini API can find a "-" and a ":" it will look for any of the sub filters. These advanced employee/user lookup filters may be combined in any order. Only add the ones that you want or need. If they (the special filters) are not present, the general search will be used.
|
Samples:
No filter
https://data0.adilas.biz/web/adilas_mini_api_calls.cfm?useCorpKeyId=USE-0053&mode=show&aiQuickSearch=employee%20lookup
Small filter of Johnny (could be anything)
https://data0.adilas.biz/web/adilas_mini_api_calls.cfm?useCorpKeyId=USE-0053&mode=show&aiQuickSearch=employee%20lookup%20Johnny
-Key:Value filter of a first name of Cole
https://data0.adilas.biz/web/adilas_mini_api_calls.cfm?useCorpKeyId=USE-0053&mode=show&aiQuickSearch=employee%20lookup%20-fn:cole
-Key:Value filter of a phone number of 435-258-5504
https://data0.adilas.biz/web/adilas_mini_api_calls.cfm?useCorpKeyId=USE-0053&mode=show&aiQuickSearch=employee%20lookup%20-phone:435-258-5504
-Key:Value filter of an email of adam@gmail.com
https://data0.adilas.biz/web/adilas_mini_api_calls.cfm?useCorpKeyId=USE-0053&mode=show&aiQuickSearch=employee%20lookup%20-email:adam@gmail.com
-Key:Value filter of for Hunter Sanders, using the longer filters
https://data0.adilas.biz/web/adilas_mini_api_calls.cfm?useCorpKeyId=USE-0053&mode=show&aiQuickSearch=employee%20lookup%20-last_name:sanders%20-first_name:hunter
|
If you are looking for the main API socket help file - click here.
|
