CalcXML REST Web Services - cus125 Calculator

URL

http://www.calcxml.com/rest/cus125

Properties / Request Headers

Required property: content-type=application/json
Required property: charset=UTF-8
Required header: accept=application/json

Full JSON Request

{"username": "XXXXXX","password": "XXXXXX","responseType": "raw2","returnDataTable": "true","chartLibrary": "image","language": "en","countryCode": "US","version": "1.3", "chartTitle": "Custom Chart Title", "threeD": "0", "chartHeight": "300", "chartWidth": "300","barColor1": "ddeeaa", "barColor2": "00ffff", "barColor3": "ffeb00","barColor4": "aabbcc","barColor5": "ff00ff","barColor6": "bbaa00","ttmRevenue": "0","ttmNPBT": "0","historicalGrowth": "1","industryName": "1","benchmarkStatus": "1","customerConcentration": "N","regulatedIndustry": "N"}

Minimal JSON Request

Optional elements will be defaulted

{"username": "XXXXXX","password": "XXXXXX","ttmRevenue": "0","ttmNPBT": "0","historicalGrowth": "1","industryName": "1","benchmarkStatus": "1","customerConcentration": "N","regulatedIndustry": "N"}

Description Of Calculator-Specific Request Elements

ttmRevenue Data type: xs:double Valid values: 0 to 999999999
ttmNPBT Data type: xs:double Valid values: 0 to 999999999
historicalGrowth Data type: xs:string Valid values: 1 (Less than 5%), 2 (5% to 10%), 3 (10% to 15%), 4 (Over 15%)
industryName Data type: xs:string Valid values: 1 (Advertising), 2 (Aerospace/Defense), 3 (Air Transport), 4 (Apparel), 5 (Auto and Truck), 6 (Auto Parts), 7 (Bank (Money Center)), 8 (Banks (Regional)), 9 (Beverage (Alcoholic)), 10 (Beverage (Soft)), 11 (Broadcasting), 12 (Brokerage and Investment Banking), 13 (Building Materials), 14 (Business and Consumer Services), 15 (Cable TV), 16 (Chemical (Basic)), 17 (Chemical (Diversified)), 18 (Chemical (Specialty)), 19 (Coal and Related Energy), 20 (Computer Services), 21 (Computers/Peripherals), 22 (Construction Supplies), 23 (Diversified), 24 (Drugs (Biotechnology)), 25 (Drugs (Pharmaceutical)), 26 (Education), 27 (Electrical Equipment), 28 (Electronics (Consumer and Office)), 29 (Electronics (General)), 30 (Engineering/Construction), 31 (Entertainment), 32 (Environmental and Waste Services), 33 (Farming/Agriculture), 34 (Financial Svcs. (Non-bank and Insurance)), 35 (Food Processing), 36 (Food Wholesalers), 37 (Furn/Home Furnishings), 38 (Green and Renewable Energy), 39 (Healthcare Products), 40 (Healthcare Support Services), 41 (Heathcare Information and Technology), 42 (Homebuilding), 43 (Hospitals/Healthcare Facilities), 44 (Hotel/Gaming), 45 (Household Products), 46 (Information Services), 47 (Insurance (General)), 48 (Insurance (Life)), 49 (Insurance (Prop/Cas.)), 50 (Investments and Asset Management), 51 (Machinery), 52 (Metals and Mining), 53 (Office Equipment and Services), 54 (Oil/Gas (Integrated)), 55 (Oil/Gas (Production and Exploration)), 56 (Oil/Gas Distribution), 57 (Oilfield Svcs/Equip.), 58 (Packaging and Container), 59 (Paper/Forest Products), 60 (Power), 61 (Precious Metals), 62 (Publishing and Newspapers), 63 (R.E.I.T.), 64 (Real Estate (Development)), 65 (Real Estate (General/Diversified)), 66 (Real Estate (Operations and Services)), 67 (Recreation), 68 (Reinsurance), 69 (Restaurant/Dining), 70 (Retail (Automotive)), 71 (Retail (Building Supply)), 72 (Retail (Distributors)), 73 (Retail (General)), 74 (Retail (Grocery and Food)), 75 (Retail (REITs)), 76 (Retail (Special Lines)), 77 (Rubberand Tires), 78 (Semiconductor), 79 (Semiconductor Equip), 80 (Shipbuilding and Marine), 81 (Shoe), 82 (Software (Entertainment)), 83 (Software (Internet)), 84 (Software (System and Application)), 85 (Steel), 86 (Telecom (Wireless)), 87 (Telecom. Equipment), 88 (Telecom. Services), 89 (Tobacco), 90 (Transportation), 91 (Transportation (Railroads)), 92 (Trucking), 93 (Utility (General)), 94 (Utility (Water))
benchmarkStatus Data type: xs:string Valid values: 1 (Higher), 2 (At Par), 3 (Lower)
customerConcentration Data type: xs:string Valid values: N (No), Y (Yes)
regulatedIndustry Data type: xs:string Valid values: N (No), Y (Yes)

See a functioning version of this calculator here: http://www.calcxml.com/do/cus125

Description Of Shared Request Elements

username - Provided by CalcXML
password - Provided by CalcXML
responseType - While there are various responseTypes, the only values that really make sense for REST integrations are raw, raw2 and pdf. raw2 includes result paragraphs/text where raw does not. pdf returns a URL to the generated PDF. Default: raw2.
returnDataTable - Indicates whether the detailed data table should be included in the response. Valid values: true or false. Default: true
chartLibrary - Indicates what type of chart should be generated. Valid values: image or flash. Default value: image
language - 2-character language code. Conform to ISO 639-1 Code. Used in conjunction with countryCode to format currency values. Find the full list here: http://www.loc.gov/standards/iso639-2/php/English_list.php. Default: en
countryCode - 2-character country code. Conform to ISO 3166-1-alpha-2. Used to format currency values that are returned in the response. Find the full list here: http://www.iso.org/iso/english_country_names_and_code_elements OR here: http://countrycode.org/. Default: US
version - The version of the schema being used for this request. Current/Default = 1.3
chartTitle - Change the chart title for the image.
threeD - Use a 3d effect when rendering the chart. Use 0 to disable. Use 1 to enable. Default = 1
chartHeight - Specify a height in pixels for the image. Default = 300
chartWidth - Specify a width in pixels for the image. Default = 400
barColor1 - Specify a custom chart color in hexadecimal.
barColor2 - Specify a custom chart color in hexadecimal.
barColor3 - Specify a custom chart color in hexadecimal.
barColor4 - Specify a custom chart color in hexadecimal.
barColor5 - Specify a custom chart color in hexadecimal.
barColor6 - Specify a custom chart color in hexadecimal.