Description Of Calculator-Specific Request Elements
clientFirstName Data type: xs:string Valid values: 0 to 999999999 spouseFirstName Data type: xs:string Valid values: 0 to 999999999 clientLastName 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 clientDOB Data type: xs:string Valid values: 0 to 999999999 spouseDOB 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 clientIncome Data type: xs:double Valid values: 0 to 999999999 spouseIncome Data type: xs:double Valid values: 0 to 999999999 clientPayIncreases Data type: xs:float Valid values: 0 to .20 spousePayIncreases Data type: xs:float Valid values: 0 to .20 clientRetirementAge Data type: xs:integer Valid values: 1 to 120 spouseRetirementAge Data type: xs:integer Valid values: 1 to 120 assetValue1 Data type: xs:double Valid values: 0 to 999999999 assetValue2 Data type: xs:double Valid values: 0 to 999999999 clientDisabilityPension Data type: xs:double Valid values: 0 to 999999999 spouseDisabilityPension Data type: xs:double Valid values: 0 to 999999999 clientDisabilityPensionIndex Data type: xs:string Valid values: N (No), Y (Yes) spouseDisabilityPensionIndex Data type: xs:string Valid values: N (No), Y (Yes) clientAge Data type: xs:string Valid values: 0 to 999999999 spouseAge Data type: xs:string Valid values: 0 to 999999999 disabilityCompany1 Data type: xs:string Valid values: 0 to 999999999 disabilityPremium1 Data type: xs:double Valid values: 0 to 999999999 disabilityInsured1 Data type: xs:string Valid values: Client, Spouse disabilityBenefit1 Data type: xs:double Valid values: 0 to 999999999 disabilityWaiting1 Data type: xs:integer Valid values: 0 to 999999999 disabilityBenefitYears1 Data type: xs:integer Valid values: 0 to 999999999 disabilityMaximumAge1 Data type: xs:integer Valid values: 0 to 120 disabilityIndexed1 Data type: xs:string Valid values: N (No), Y (Yes) disabilityCompany2 Data type: xs:string Valid values: 0 to 999999999 disabilityPremium2 Data type: xs:double Valid values: 0 to 999999999 disabilityInsured2 Data type: xs:string Valid values: Client, Spouse disabilityBenefit2 Data type: xs:double Valid values: 0 to 999999999 disabilityWaiting2 Data type: xs:integer Valid values: 0 to 999999999 disabilityBenefitYears2 Data type: xs:integer Valid values: 0 to 999999999 disabilityMaximumAge2 Data type: xs:integer Valid values: 0 to 120 disabilityIndexed2 Data type: xs:string Valid values: N (No), Y (Yes) disabilityCompany3 Data type: xs:string Valid values: 0 to 999999999 disabilityPremium3 Data type: xs:double Valid values: 0 to 999999999 disabilityInsured3 Data type: xs:string Valid values: Client, Spouse disabilityBenefit3 Data type: xs:double Valid values: 0 to 999999999 disabilityWaiting3 Data type: xs:integer Valid values: 0 to 999999999 disabilityBenefitYears3 Data type: xs:integer Valid values: 0 to 999999999 disabilityMaximumAge3 Data type: xs:integer Valid values: 0 to 120 disabilityIndexed3 Data type: xs:string Valid values: N (No), Y (Yes) disabilityCompany4 Data type: xs:string Valid values: 0 to 999999999 disabilityPremium4 Data type: xs:double Valid values: 0 to 999999999 disabilityInsured4 Data type: xs:string Valid values: Client, Spouse disabilityBenefit4 Data type: xs:double Valid values: 0 to 999999999 disabilityWaiting4 Data type: xs:integer Valid values: 0 to 999999999 disabilityBenefitYears4 Data type: xs:integer Valid values: 0 to 999999999 disabilityMaximumAge4 Data type: xs:integer Valid values: 0 to 120 disabilityIndexed4 Data type: xs:string Valid values: N (No), Y (Yes) clientSpending1 Data type: xs:double Valid values: 0 to 999999999 clientSpending1Years Data type: xs:integer Valid values: 0 to 999999999 clientSpending2 Data type: xs:double Valid values: 0 to 999999999 clientSpending2Years Data type: xs:integer Valid values: 0 to 999999999 spouseSpending1 Data type: xs:double Valid values: 0 to 999999999 spouseSpending1Years Data type: xs:integer Valid values: 0 to 999999999 spouseSpending2 Data type: xs:double Valid values: 0 to 999999999 spouseSpending2Years Data type: xs:integer Valid values: 0 to 999999999 spouseIncomeChange Data type: xs:double Valid values: -999999999 to 999999999 clientIncomeChange Data type: xs:double Valid values: -999999999 to 999999999 child1Age Data type: xs:integer Valid values: 0 to 120 child2Age Data type: xs:integer Valid values: 0 to 120 child3Age Data type: xs:integer Valid values: 0 to 120 child4Age Data type: xs:integer Valid values: 0 to 120 child5Age Data type: xs:integer Valid values: 0 to 120 child6Age Data type: xs:integer Valid values: 0 to 120 preRetirementReturn Data type: xs:float Valid values: -.12 to .12 combinedMarginalTaxRate Data type: xs:float Valid values: 0 to .75 inflation Data type: xs:float Valid values: 0 to .10 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.