Description Of Calculator-Specific Request Elements
clientFirstName Data type: xs:string Valid values: 0 to 999999999 clientLastName Data type: xs:string Valid values: 0 to 999999999 spouseFirstName Data type: xs:string Valid values: 0 to 999999999 spouseLastName Data type: xs:string Valid values: 0 to 999999999 scenarioDescription Data type: xs:string Valid values: 0 to 999999999 clientAddress Data type: xs:string Valid values: 0 to 999999999 clientCity Data type: xs:string Valid values: 0 to 999999999 clientState Data type: xs:string Valid values: 0 to 999999999 clientZip Data type: xs:string Valid values: 0 to 999999999 clientPhone Data type: xs:string Valid values: 0 to 999999999 advisorName Data type: xs:string Valid values: 0 to 999999999 advisorTitle Data type: xs:string Valid values: 0 to 999999999 advisorCompanyName Data type: xs:string Valid values: 0 to 999999999 companyAddress1 Data type: xs:string Valid values: 0 to 999999999 companyAddress2 Data type: xs:string Valid values: 0 to 999999999 companyCity Data type: xs:string Valid values: 0 to 999999999 companyState Data type: xs:string Valid values: 0 to 999999999 companyZip Data type: xs:string Valid values: 0 to 999999999 companyPhone Data type: xs:string Valid values: 0 to 999999999 child1Name Data type: xs:string Valid values: 0 to 999999999 child1DOB Data type: xs:string Valid values: 0 to 999999999 child1School Data type: xs:string Valid values: 0 to 999999999 child1Cost Data type: xs:double Valid values: 0 to 999999999 child1SavingsTaxable Data type: xs:double Valid values: 0 to 999999999 child1Savings529 Data type: xs:double Valid values: 0 to 999999999 child1ParentsPay Data type: xs:float Valid values: 0 to 1 child1StartAge Data type: xs:integer Valid values: 0 to 30 child1YearsNeeded Data type: xs:integer Valid values: 0 to 20 child2Name Data type: xs:string Valid values: 0 to 999999999 child2DOB Data type: xs:string Valid values: 0 to 999999999 child2School Data type: xs:string Valid values: 0 to 999999999 child2Cost Data type: xs:double Valid values: 0 to 999999999 child2SavingsTaxable Data type: xs:double Valid values: 0 to 999999999 child2Savings529 Data type: xs:double Valid values: 0 to 999999999 child2ParentsPay Data type: xs:float Valid values: 0 to 1 child2StartAge Data type: xs:integer Valid values: 0 to 30 child2YearsNeeded Data type: xs:integer Valid values: 0 to 20 child3Name Data type: xs:string Valid values: 0 to 999999999 child3DOB Data type: xs:string Valid values: 0 to 999999999 child3School Data type: xs:string Valid values: 0 to 999999999 child3Cost Data type: xs:double Valid values: 0 to 999999999 child3SavingsTaxable Data type: xs:double Valid values: 0 to 999999999 child3Savings529 Data type: xs:double Valid values: 0 to 999999999 child3ParentsPay Data type: xs:float Valid values: 0 to 1 child3StartAge Data type: xs:integer Valid values: 0 to 30 child3YearsNeeded Data type: xs:integer Valid values: 0 to 20 child4Name Data type: xs:string Valid values: 0 to 999999999 child4DOB Data type: xs:string Valid values: 0 to 999999999 child4School Data type: xs:string Valid values: 0 to 999999999 child4Cost Data type: xs:double Valid values: 0 to 999999999 child4SavingsTaxable Data type: xs:double Valid values: 0 to 999999999 child4Savings529 Data type: xs:double Valid values: 0 to 999999999 child4ParentsPay Data type: xs:float Valid values: 0 to 1 child4StartAge Data type: xs:integer Valid values: 0 to 30 child4YearsNeeded Data type: xs:integer Valid values: 0 to 20 child5Name Data type: xs:string Valid values: 0 to 999999999 child5DOB Data type: xs:string Valid values: 0 to 999999999 child5School Data type: xs:string Valid values: 0 to 999999999 child5Cost Data type: xs:double Valid values: 0 to 999999999 child5SavingsTaxable Data type: xs:double Valid values: 0 to 999999999 child5Savings529 Data type: xs:double Valid values: 0 to 999999999 child5ParentsPay Data type: xs:float Valid values: 0 to 1 child5StartAge Data type: xs:integer Valid values: 0 to 30 child5YearsNeeded Data type: xs:integer Valid values: 0 to 20 child6Name Data type: xs:string Valid values: 0 to 999999999 child6DOB Data type: xs:string Valid values: 0 to 999999999 child6School Data type: xs:string Valid values: 0 to 999999999 child6Cost Data type: xs:double Valid values: 0 to 999999999 child6SavingsTaxable Data type: xs:double Valid values: 0 to 999999999 child6Savings529 Data type: xs:double Valid values: 0 to 999999999 child6ParentsPay Data type: xs:float Valid values: 0 to 1 child6StartAge Data type: xs:integer Valid values: 0 to 30 child6YearsNeeded Data type: xs:integer Valid values: 0 to 20 collegeInflation Data type: xs:float Valid values: 0 to .10 collegeReturn Data type: xs:float Valid values: -.12 to .12 preRetirementTaxRate Data type: xs:float Valid values: 0 to .75 collegeSavingsIncrease Data type: xs:float Valid values: 0 to .2 child1Age Data type: xs:string Valid values: 0 to 999999999 child2Age Data type: xs:string Valid values: 0 to 999999999 child3Age Data type: xs:string Valid values: 0 to 999999999 child4Age Data type: xs:string Valid values: 0 to 999999999 child5Age Data type: xs:string Valid values: 0 to 999999999 child6Age Data type: xs:string Valid values: 0 to 999999999 color1 Data type: xs:string Valid values: 0 to 999999999 color2 Data type: xs:string Valid values: 0 to 999999999 color3 Data type: xs:string Valid values: 0 to 999999999 color4 Data type: xs:string Valid values: 0 to 999999999 color5 Data type: xs:string Valid values: 0 to 999999999 color6 Data type: xs:string Valid values: 0 to 999999999 disclaimer1 Data type: xs:string Valid values: 0 to 999999999 disclaimer2 Data type: xs:string Valid values: 0 to 999999999 disclaimer3 Data type: xs:string Valid values: 0 to 999999999 disclaimer4 Data type: xs:string Valid values: 0 to 999999999 ppid Data type: xs:string Valid values: 0 to 999999999 moduleTitle Data type: xs:string Valid values: 0 to 999999999
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.