all data is live and searchable
« Back . [api documentation and samples] . [view sample]
Main Web API Documentation Information
Actual Page/Function Name:
getSpecificCorpWideSettings
Human Readable Name or Caption:
Get Specific Corp Wide Settings
Page/Function Description:
This page will allow a user to get a list of corp wide settings for a given corporation.
Page/Function Output Type:
API - JSON or WDDX
Categories:
general
Extra Page/Function Notes:
Created By: Alan Williams


Parameters
Scope Name Type Default Description Required Alternates Known Values
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 FIELD_LIST String Pass in a comma separated list of desired corp-wide settings. If you want all corp-wide settings at once, use the string all. As a note, this database table has over 200+ fields and settings that are held per corporation (world level settings).

Here are some possible values that you could search for:
  • advanced_add_switch - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • allow_cross_corp_billing - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • auto_restore_rfid - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • barcode_quick_cart - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • calendar_block_size - will return a numeric with the following values:
    • 60 = Block Size - XS
    • 100 = Block Size - Sm
    • 150 = Block Size - Med
    • 200 = Block Size - Lg
    • 300 = Block Size - XL
  • cart_quick_search_list - will return a numeric with the following values:
    • 1 = Part Numbers
    • 2 = Flex Grid Tie-Ins
    • 3 = Recipe/Builds
    • 4 = Cart Favorite Buttons
    • 5 = Barcodes (mixed sorces)
  • cc_payment_mode - will return a numeric with the following values:
    • 1 = General - Allow Both (swipe & manual)
    • 2 = Card Present - Retail - Swiped
    • 3 = Card Not Present - Manually Keyed
  • checkout_payment_number - number of payment options
  • corp_id
  • corp_initials
  • corp_inventory_type_name
  • corp_make_name
  • corp_model_name
  • corp_name
  • corp_stock_name
  • corp_stock_name_full
  • corp_sub_inventory_type_name
  • corp_vin_name - vin or serial number name
  • custom_disclaimer_id - will return a numeric with the following values:
    • 1 = Standalone - Available upon request
    • 2 = In-Line - Show on every invoice/quote
  • custom_disclaimer_text
  • customer_end_date_name
  • customer_invoice_name
  • customer_invoice_short
  • customer_queue_name
  • customer_queue_short
  • customer_search_type_id - will return a numeric with the following values:
    • 1 = Business Name
    • 2 = Last name
    • 3 = First Name
    • 4 = Any Name
  • customer_start_date_name
  • customer_tax_name
  • default_barcode_size - will return a numeric with the following values:
    • 1 = 3/4" x 2" - End-To-End
    • 2 = 2" x 3/4" - Stacked
    • 3 = 1" x 2" - End-To-End
    • 4 = 2" x 1" - Stacked
    • 5 = 2 1/4" x 1 1/4" - Stacked
    • 6 = 2 1/4" x 1 3/8" - Stacked
  • default_corp_type
  • default_corp_type_short
  • default_customer_name
  • default_customer_short
  • default_customer_terms
  • default_discount_type - will return a numeric with the following values:
    • 1 = Use in-line discounts
    • 2 = Use standalone discounts
  • default_loc_name
  • default_loc_short
  • default_part_name
  • default_part_number
  • default_part_number_short
  • default_part_short
  • default_printable_invoice
  • default_recalc_payroll - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • default_recalc_taxes - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • default_salesperson_name
  • default_salesperson_short
  • default_time_period - will return a numeric with the following values:
    • 1 = Show Daily Results
    • 2 = Show Weekly Results
    • 3 = Show Monthly Results
  • default_time_report_type
  • discount_campaign_settings
  • discount_requires_manager_approval - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • external_po_name
  • from_physical_day
  • from_physical_month
  • invoice_extra_line_1
  • invoice_extra_line_2
  • invoice_extra_line_3
  • invoice_show_signature_1 - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • invoice_show_signature_2 - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • invoice_signature_text_1
  • invoice_signature_text_2
  • invoice_thank_you_line
  • limited_invoice_name
  • loc_license_name
  • lock_down_date
  • number_of_decimals
  • part_mark_up
  • period_end_date_name
  • period_start_date_name
  • po_name_basic_live
  • po_name_basic_request
  • po_name_special_live
  • po_name_special_request
  • queue_flush_rate - time displayed in minutes.
  • quick_cash_checkout - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • store_quote_to_cart_setting
  • rfid_tag_number_name
  • show_bin_numbers - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • show_contact_page - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • show_corp_on_web - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • show_invoice_conversions - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • show_line_num_dep - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • show_line_num_inv - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • show_line_num_po - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • show_line_num_rec - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • show_parts_on_web - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • show_parts_prices - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • show_signature_1_invoice - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • show_signature_1_limited - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • show_signature_1_mini - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • show_signature_2_invoice - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • show_signature_2_limited - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • show_signature_2_mini - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • show_tax_breakdown - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • show_taxes - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • show_unit_of_measure - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • show_unit_prices - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • show_units_on_web - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • specific_unit_name
  • tax_category_id - will return a numeric with the following values:
    • 2 = Taxable
    • 3 = Resale
    • 4 = Labor
    • 5 = Misc
    • 6 = Religious
    • 7 = Government
    • 8 = Freight
    • 9 = Sublet
    • 10 = Deposit
    • 12 = Internal
    • 13 = Delivery
    • 14 = Disposal
    • 15 = Farm Use
    • 16 = Out of State
    • 17 = With Tax Included
    • 18 = Wholesale
  • tax_fee_1
  • tax_fee_2
  • tax_fee_3
  • tax_fee_4
  • tax_fee_5
  • tax_fee_6
  • time_show_group_subs - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • time_slot_block_size
  • time_slot_end_range
  • time_slot_frequency_id - will return a numeric with the following values:
    • 2 = Seconds
    • 3 = Minutes
    • 4 = Hours
  • time_slot_start_range
  • title_parts
  • to_physical_day
  • to_physical_month
  • transition_invoice_name
  • transition_invoice_short
  • use_customer_queue - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • use_external_po - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • use_loc_specific_inventory - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • use_review_cart - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • use_rfid_tag_numbers - will return a numeric with the following values:
    • 0 = off
    • 1 = on
  • vendor_search_type_id - will return a numeric with the following values:
    • 1 = Business Name
    • 2 = Last name
    • 3 = First Name
    • 4 = Any Name
  • web_price_name
  • web_price_short
  • web_return_address
For more in depth information for corp wide settings look at the corp wide settings page or the corp wide settings help page 		Yes


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_CORP_SETTINGS_ARRAY Array This array contains all the specified corp wide settings for the given corp. This contains the settings that are specified or all settings if field contains "all".
validationError Check the field list value. The values submitted are not allowed. Please make sure you only enter in characters, digits, commas, spaces and underscores. This is returned if the FIELD_LIST value has a special symbol that is not allowed.
dataIn Unable to get the limited list of corporation-wide settings requested. Missing some data. check your corp id and field list and try again. This is returned if the value of the CORP_ID is missing or the FIELD_LIST is missing.
fieldListError Unable to get the corporation-wide settings requested. Some values submitted are not allowed. Please make sure you only enter in characters, digits, commas, spaces and underscores. Check your field list and try again. This is returned if the FIELD_LIST has invalid symbols.
db Unable to connect to the database. Missing a limited list of corporation-wide settings and defaults. Check that your requested field list is accurate. This message is returned if one of field names is invalid.
zero Unable to find the limited list of corporation-wide settings and defaults requested. Use your back button and try again. This message is returned if the corp wide settings for the specified corp does not exist.


Samples
Caption Text
JSON
{"API_URL_ENCODING":"AUTO","API_CURRENT_PAYEE_ID":3,"API_CORP_KEY_ID":"PLA-0053","API_USER_PASSWORD":1234,"API_CALL_FUNCTION_NAME":"getspecificcorpwidesettings","API_INPUT_OUTPUT_TYPE":"JSON","API_USER_NAME":"demo","CORP_ID":53,"FIELD_LIST":"corp_id, corp_name, default_customer_name, discount_campaign_settings"}