CalcXML REST Web Services - qua14 Calculator

URL

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

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","yyyyRmd": "2024","dobMmOwner": "1","dobDdOwner": "1","dobYyyyOwner": "1950","dodMmOwner": "1","dodDdOwner": "1","dodYyyyOwner": "1950","dobMmBeneficiary": "1","dobDdBeneficiary": "1","dobYyyyBeneficiary": "1950","planBalance": "0","returnRate": "0.08","planType": "1","beneficiaryType": "1"}

Minimal JSON Request

Optional elements will be defaulted

{"username": "XXXXXX","password": "XXXXXX","yyyyRmd": "2024","dobMmOwner": "1","dobDdOwner": "1","dobYyyyOwner": "1950","dodMmOwner": "1","dodDdOwner": "1","dodYyyyOwner": "1950","dobMmBeneficiary": "1","dobDdBeneficiary": "1","dobYyyyBeneficiary": "1950","planBalance": "0","returnRate": "0.08","planType": "1","beneficiaryType": "1"}

Description Of Calculator-Specific Request Elements

yyyyRmd Data type: xs:integer Valid values: 2010 to 2040
dobMmOwner Data type: xs:integer Valid values: 1 to 12
dobDdOwner Data type: xs:integer Valid values: 1 to 31
dobYyyyOwner Data type: xs:integer Valid values: 1920 to 2024
dodMmOwner Data type: xs:integer Valid values: 1 to 12
dodDdOwner Data type: xs:integer Valid values: 1 to 31
dodYyyyOwner Data type: xs:integer Valid values: 1920 to 2040
dobMmBeneficiary Data type: xs:integer Valid values: 1 to 12
dobDdBeneficiary Data type: xs:integer Valid values: 1 to 31
dobYyyyBeneficiary Data type: xs:integer Valid values: 1920 to 2024
planBalance Data type: xs:double Valid values: 0 to 999999999
returnRate Data type: xs:float Valid values: 0 to .10
planType Data type: xs:string Valid values: 1 (Traditional IRA), 2 (Roth IRA), 3 (Traditional 401(k)), 4 (Roth 401(k)), 5 (457), 6 (Roth 457), 7 (403(b)), 8 (Roth 403(b)), 9 (Pension Plan), 10 (SARSEP), 11 (SEP), 12 (SIMPLE), 13 (Other qualified pretax account), 14 (Other qualified Roth account)
beneficiaryType Data type: xs:string Valid values: 1 (Surviving spouse), 2 (Non-spouse individual), 3 (Disabled or chronically ill individual), 4 (Account owner's child)

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

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.