CalcXML REST Web Services - cus73 Calculator

URL

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

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","region": "1","cityRural": "1","parent": "N","annualIncome": "1","childAge": "1","college": "1"}

Minimal JSON Request

Optional elements will be defaulted

{"username": "XXXXXX","password": "XXXXXX","region": "1","cityRural": "1","parent": "N","annualIncome": "1","childAge": "1","college": "1"}

Description Of Calculator-Specific Request Elements

region Data type: xs:integer Valid values: 1 (Northeast), 2 (Midwest), 3 (South), 4 (West)
cityRural Data type: xs:integer Valid values: 1 (City or Suburb), 2 (Rural area - population under 2500)
parent Data type: xs:string Valid values: N (No), Y (Yes)
annualIncome Data type: xs:integer Valid values: 1 (Less than $61,530), 2 (Greater than $61,530), 3 (Less than $62,500), 4 ($62,500 to $108,210), 5 (Greater than $108,210), 6 (Less than $61,680), 7 ($61,680 to $106,800), 8 (Greater than 108,800), 9 (Less than $61,300), 10 ($61,300 to $106,140), 11 (Greater than $106,140), 12 (Less than $62,010), 13 ($62,010 to $107,360), 14 (Greater than $107,360), 15 (Less than $61,050), 16 ($61,050 to $105,700), 17 (Greater than $105,700)
childAge Data type: xs:integer Valid values: 1 (0-2), 2 (3-5), 3 (6-8), 4 (9-11), 5 (12-14), 6 (15-17)
college Data type: xs:integer Valid values: 1 (No), 2 (Yes - Public), 3 (Yes - Private)

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

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.