CalcXML REST Web Services - cus84 Calculator

URL

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

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","state": "Alabama","initialAge": "50","horizon": "10","retirementPeriodLength": "30","initialInvestment": "500000","preRetirement": "300000","postRetirement": "150000","inflation": "0","investmentStrategy": "Moderate","variableAnnuityExpenses": "0.011","taxableAdvisorFees": ".01","withdrawalPercentage": "0","calculateBreakeven": "N"}

Minimal JSON Request

Optional elements will be defaulted

{"username": "XXXXXX","password": "XXXXXX","state": "Alabama","initialAge": "50","horizon": "10","retirementPeriodLength": "30","initialInvestment": "500000","preRetirement": "300000","postRetirement": "150000","inflation": "0","investmentStrategy": "Moderate","variableAnnuityExpenses": "0.011","taxableAdvisorFees": ".01","withdrawalPercentage": "0","calculateBreakeven": "N"}

Description Of Calculator-Specific Request Elements

state Data type: xs:string Valid values: Alabama, Alaska, Arkansas, Arizona, California, Colorado, Connecticut, Delaware, Florida, Georgia, Hawaii, Idaho, Illinois, Indiana, Iowa, Kansas, Kentucky, Louisiana, Maine, Maryland, Massachusetts, Michigan, Minnesota, Mississippi, Missouri, Montana, Montana (Nebraska), Nevada, NH (New Hampshire), NJ (New Jersey), NM (New Mexico), NY (New York), NC (North Carolina), ND (North Dakota), Ohio, Oklahoma, Oregon, Pennsylvania, RI (Rhode Island), SC (South Carolina), SD (South Dakota), Tennessee, Texas, Utah, Vermont, Virginia, Washington, WV (West Virginia), Wisconsin, Wyoming, DC (District Of Columbia)
initialAge Data type: xs:integer Valid values: 1 to 120
horizon Data type: xs:double Valid values: 0 to 999999999
retirementPeriodLength Data type: xs:integer Valid values: 1 to 30
initialInvestment Data type: xs:double Valid values: 0 to 999999999
preRetirement Data type: xs:double Valid values: 0 to 999999999
postRetirement Data type: xs:double Valid values: 0 to 999999999
inflation Data type: xs:float Valid values: 0 to .12
investmentStrategy Data type: xs:string Valid values: Conservative, Moderate, Aggressive, Custom
variableAnnuityExpenses Data type: xs:float Valid values: 0 to .12
taxableAdvisorFees Data type: xs:float Valid values: 0 to .12
withdrawalPercentage Data type: xs:float Valid values: 0 to .12
calculateBreakeven Data type: xs:string Valid values: N (No), Y (Yes)

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

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.