all data is live and searchable
« Back . [api documentation and samples] . [view sample]
Main Web API Documentation Information
Actual Page/Function Name:
getStandAloneFlexGrid
Human Readable Name or Caption:
Get Stand Alone Flex Grid
Page/Function Description:
This method will get all flex grid tie-in items for a single main id or type.
Page/Function Output Type:
API - JSON or WDDX
Categories:
eComm,flex grid,general
Extra Page/Function Notes:
The flex grid is the extra "duct tape and baling twine" for the application. To learn more about the flex grid, go to the following address and search for the word "flex." www.adilas.biz/top_secret/all_help_files.cfm


Parameters
Scope Name Type Default Description Required Alternates Known Values
Arguments ADMIN_STATUS String Pass in the value ok for allow admin records. Any other value will not show the admin values. No
Arguments APP_TYPE_ID Numeric 0 Pass in the main application type id number. 2=Deposit, 3=Invoice, 4=PO, 5=Expense/Receipt, 6=Balance Sheet Item, 7=Stock/Unit, 8=Customer, 9=Vendor/Payee, 10=Employee, 11=Part, 12=Element of Time, 13=Quote. 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 FROM_DATE String Pass in the from date range or leave it blank to skip. No
Arguments LINK_ENABLED String YES Pass in the string yes or no. This deals with the drill-down links. Yes
Arguments MAIN_ID Numeric 0 Pass in the main id tie-in number. These are things like invoice numbers, part ids, customer ids, deposit numbers, po numbers, etc. They associate with the app type ids. Yes
Arguments PRINTABLE_FLAG String all Pass in the string all, 1, or 0. Behind the scenes, the printable flag is used to let us know whether the piece of flex grid is transparent or whether it shows up on the main. It's a way to hide things but still keep them attached. 1=show, 0=transparent. No
Arguments TO_DATE String Pass in the to date range or leave it blank to skip. No


Results
RET_STATUS RET_MAIN_MESSAGE RET_SECOND_MESSAGE Redirect Link Description
ok success This assumes that everything went well.
Name Type Description Notes
QRY_FLEX_GRID_TIE_INS_ARRAY Array This array grabs all the matching flex grid tie-ins and converts any strings to numeric lengths. This contains values such as admin only flag, app type id, balance sheet number, etc.
PRINTABLE_COUNT Numeric This is the total number of printable records. See description.
TRANSPARENT_COUNT Numeric This is the total number of transparent flex grid items. See description.
ADMIN_COUNT Numeric This is the total number of records that has been marked as admin only. See description.
NORMAL_COUNT Numeric This is the total number of records not marked as admin only. See description.
TOTAL_COUNT Numeric This is the total number of records. See description.
ADJUSTED_COUNT Numeric This is the total number of records not marked as admin only. See description.
MAIN_FLEX_FORMAT_ARRAY Array This is the master array for the flex grid format. This holds the show/hide value, the column titles, and the alignment.
FLEX_GRID_DATA_ARRAY Array This array holds the actual data. See description.
MAIN_FLEX_COLUMN_COUNT Numeric This is the total number of columns in the main flex format array. See description.
dataIn Unable to get the flex grid tie-in line items or assignments. Missing some data. Use your back button and try again. This is returned if you're missing any of the required arguments (app type id, corp id, or main id).
corpSettings Missing the correct corp-wide settings. Unable to proceed. Use your back button and try again. This is returned if no records are found for the selected corp id.
zero Unable to find any matching flex grid tie-ins (assignments) for the main item (main player) requested. Use your back button and try again. This is returned if no records were found associated with the requested main item.
zero Unable to find any matching flex grid tie-ins (assignments) that were not marked admin only. The current flex grid tie-in assignments have [---] admin only item(s). Use your back button and try again. This is returned if there are no records found where the admin only flag is 0.
db Unable to connect to the database. Missing a list of flex grid tie-in items. Use your back button and try again. This is returned if there was an error in querying any of the following values: deposit number, invoice number, po number, receipt number, stock, customer id, part id, etc.
db2 Unable to format the flex grid tie-in output. Use your back button and try again. This is returned if there was any error in putting the flex grid tie-in into an array.


Samples
Caption Text
JSON
{"ADMIN_STATUS":"ok","TO_DATE":"01/01/16","API_CALL_FUNCTION_NAME":"getStandaloneFlexGrid","LINK_ENABLED":false,"FROM_DATE":"01/01/10","MAIN_ID":305,"API_URL_ENCODING":"AUTO","API_CURRENT_PAYEE_ID":3,"API_USER_PASSWORD":1234,"API_CORP_KEY_ID":"PLA-0053","APP_TYPE_ID":3,"CORP_ID":53,"API_INPUT_OUTPUT_TYPE":"JSON","PRINTABLE_FLAG":1,"API_USER_NAME":"demo"}