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:
|
Yes |
Results
|
||||||||||||
RET_STATUS | RET_MAIN_MESSAGE | RET_SECOND_MESSAGE | Redirect Link | Description | ||||||||
ok | success | This assumes that everything went well. | ||||||||||
|
||||||||||||
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"}
|