all data is live and searchable
« Back . [api documentation and samples] . [view sample]
Main Web API Documentation Information
Actual Page/Function Name:
getCorpWideSettings
Human Readable Name or Caption:
Get Corp Wide Settings
Page/Function Description:
This method will get the corporation-wide settings and defaults for a single corporation.
Page/Function Output Type:
API - JSON or WDDX
Categories:
eComm,general
Extra Page/Function Notes:
As a note, the corporations table has 200 settings and values that are used to give each world its own flavor and flair.


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


Results
RET_STATUS RET_MAIN_MESSAGE RET_SECOND_MESSAGE Redirect Link Description
ok success This assumes that everything went well.
Name Type Description Notes
CORP_WIDE_SETTINGS_ARRAY Array This array contains all the corp-wide settings. This has values such as calendar block size, search list, payment mode, payment number, corp id, default part number, show unit of measure, etc. There are well over 50 different values here.
dataIn Unable to get the corporation-wide settings requested. Missing some data. Use your back button and try again. This is returned if the corp id value is missing.
db Unable to connect to the database. Missing a list of corporation-wide settings and defaults. Use your back button and try again. This is a catch for any errors that happen while trying to query for values such as advanced add switch, barcode quick cart, calendar block size, corp make name, corp stock name, customer invoice name, etc. There are about 120 different values here.
zero Unable to find the corporation-wide settings and defaults requested. Use your back button and try again. This is returned if the query for the corp-wide settings returns a "0" record count.


Samples
Caption Text
JSON
{"API_CALL_FUNCTION_NAME":"getCorpWideSettings","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"}