all data is live and searchable
« Back . [api documentation and samples] . [view sample]
Main Web API Documentation Information
Actual Page/Function Name:
validateCorpId
Human Readable Name or Caption:
Validate Corporation Id
Page/Function Description:
This page will validate a corporation key that is passed in. The corp key is a key value that defines one corp from another. Kinda like a virtual username but at the world or corporation level.
Page/Function Output Type:
API - JSON or WDDX
Categories:
eComm
Extra Page/Function Notes:
Used on almost every eCommerce web or API call. This method will be called sometimes, even if not specifically asked. This is a form of light corporation or world validation from a customer facing page or API socket.


Parameters
Scope Name Type Default Description Required Alternates Known Values
Arguments CORP_KEY_ID String Pass in the corporation key. Yes


Results
RET_STATUS RET_MAIN_MESSAGE RET_SECOND_MESSAGE Redirect Link Description
passed success This assumes that everything went well.
Name Type Description Notes
QRY_CORP_INFO_ARRAY Array This is a query to check a corporation and see if it is real and/or allows web searches. This queries all sorts of information like background color, inventory type name, corp logo, invoice name, customer name, part number, wholesale price, etc. There are 50 values queried here.
CORP_ID Numeric This returns the numeric corp id value at the end of the corp key id. See description.
CORP_NAME String This is the corporation name. This is queried from the database.
stringProblem Unable to validate the corporation key. The value did not pass validation. Error Code: [code] Use your back button and try again. This is returned if the corp key id argument is not a valid string.
corpInProblem Unable to validate the corporation key. Missing some data. Use your back button and try again. This is returned if the corp key id is less than 5 characters long.
dashProblem The corporation key must have a dash in order to proceed. Example: XYZ-5555. A dash mark (-) is the same as a minus sign. Use your back button and try again. This is returned if the corp key id does not contain a dash mark (-).
corpProblem The corporation id must be numeric. Unable to proceed. Example: XYZ-5555 (where 5555 equals the corporation id number). Use your back button and try again. This is returned if the corp id is not numeric.
corpLogicProblem Unable to connect to the database. Unable to validate the corporation status. Use your back button and try again. This is a catch for any errors that occur while running tests on the corp name id or while querying the database.
zeroCorpProblem The corporation key passed in does not match anything in the database. Unable to proceed. Use your back button and try again. This is returned if zero records were found associated with the corp key id.
corpWebProblem The corporation you requested does not allow data to be shown over the web. Unable to proceed. If you know someone who works for this corporation, contact them and inform them of this error message. Use your back button and try again. This is returned if the corporation has selected a value that will not allow data to be shown over the web.
corpWebProblem2 The corporation you requested does allow data to be shown over the web but is missing some settings. Unable to proceed. If you know someone who works for this corporation, contact them and inform them of this error message. Use your back button and try again. This is returned if the corporation has the show parts and show units online values both set to "no".


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