all data is live and searchable
« Back . [api documentation and samples] . [view sample]
Main Web API Documentation Information
Actual Page/Function Name:
getBulkStockPhotos
Human Readable Name or Caption:
Get Bulk Stock Photos
Page/Function Description:
This web service will return a list of image data (not actual paths) for the list of stock/units passed in.
Page/Function Output Type:
API - JSON or WDDX
Categories:
stock/unit,photo/media
Extra Page/Function Notes:


Parameters
Scope Name Type Default Description Required Alternates Known Values
Arguments CORP_KEY_ID String Pass in the corp key id. Yes
Arguments STOCK_LIST String 0 Pass in the stock number. A list with commas in between can also be used. 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_ALL_STOCK_PHOTOS_ARRAY Array This is a descriptive array of the stock photos This will include the image caption, id, number, photographer, etc.
CORP_IMAGE_FOLDER String Custom image folder name This will be the custom image folder name that is specific per corporation. Example: corp53_5FC2B3D1C9
LARGE_FOLDER_PATH String Expanded image path This will be the expanded image path to the large image folder.
SMALL_FOLDER_PATH String Expanded image path This will be the expanded image path to the small image folder.
SAMPLE_LARGE_IMAGE_FORMAT String Path information This is a small sample path to help with formatting. It shows which parts are hardcoded (static) and which parts are not (dynamic data). This is just a sample with fake numbers and values.
stockUnitListProblem The stock/unit list must have at least one value. Unable to proceed. Use your back button and try again. The stock/unit list has no valid values.
stockLogicProblem Unable to connect to the database. Missing the list of stock/unit photos. Use your back button and try again. A valid list was not created by the stock photo query.


Samples
Caption Text
JSON
{"API_CALL_FUNCTION_NAME":"getbulkstockphotos","STOCK_LIST":"4,5","API_CORP_KEY_ID":"PLA-0053","API_USER_NAME":"demo","API_USER_PASSWORD":"1234","CORP_KEY_ID":"PLA-0053","API_CURRENT_PAYEE_ID":"3","API_INPUT_OUTPUT_TYPE":"JSON","API_URL_ENCODING":"AUTO"}