CalcXML REST Web Services - adv05 Calculator

URL

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

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","clientFirstName": "null","spouseFirstName": "null","clientLastName": "null","spouseLastName": "null","scenarioDescription": "null","clientDOB": "null","spouseDOB": "null","clientAddress": "null","clientCity": "null","clientState": "null","clientZip": "null","clientPhone": "null","advisorName": "null","advisorTitle": "null","advisorCompanyName": "null","companyAddress1": "null","companyAddress2": "null","companyCity": "null","companyState": "null","companyZip": "null","companyPhone": "null","clientIncome": "0","spouseIncome": "0","clientPayIncreases": "0","spousePayIncreases": "0","clientRetirementAge": "65","spouseRetirementAge": "65","assetValue1": "0","assetValue2": "0","clientDisabilityPension": "0","spouseDisabilityPension": "0","clientDisabilityPensionIndex": "N","spouseDisabilityPensionIndex": "N","clientAge": "null","spouseAge": "null","disabilityCompany1": "null","disabilityPremium1": "0","disabilityInsured1": "Client","disabilityBenefit1": "0","disabilityWaiting1": "0","disabilityBenefitYears1": "0","disabilityMaximumAge1": "0","disabilityIndexed1": "N","disabilityCompany2": "null","disabilityPremium2": "0","disabilityInsured2": "Client","disabilityBenefit2": "0","disabilityWaiting2": "0","disabilityBenefitYears2": "0","disabilityMaximumAge2": "0","disabilityIndexed2": "N","disabilityCompany3": "null","disabilityPremium3": "0","disabilityInsured3": "Client","disabilityBenefit3": "0","disabilityWaiting3": "0","disabilityBenefitYears3": "0","disabilityMaximumAge3": "0","disabilityIndexed3": "N","disabilityCompany4": "null","disabilityPremium4": "0","disabilityInsured4": "Client","disabilityBenefit4": "0","disabilityWaiting4": "0","disabilityBenefitYears4": "0","disabilityMaximumAge4": "0","disabilityIndexed4": "N","clientSpending1": "0","clientSpending1Years": "0","clientSpending2": "0","clientSpending2Years": "0","spouseSpending1": "0","spouseSpending1Years": "0","spouseSpending2": "0","spouseSpending2Years": "0","spouseIncomeChange": "0","clientIncomeChange": "0","child1Age": "0","child2Age": "0","child3Age": "0","child4Age": "0","child5Age": "0","child6Age": "0","preRetirementReturn": ".08","combinedMarginalTaxRate": ".25","inflation": ".03","color1": "null","color2": "null","color3": "null","color4": "null","color5": "null","color6": "null","disclaimer1": "null","disclaimer2": "null","disclaimer3": "null","disclaimer4": "null","ppid": "null","moduleTitle": "null"}

Minimal JSON Request

Optional elements will be defaulted

{"username": "XXXXXX","password": "XXXXXX","clientFirstName": "null","spouseFirstName": "null","clientLastName": "null","spouseLastName": "null","scenarioDescription": "null","clientDOB": "null","spouseDOB": "null","clientAddress": "null","clientCity": "null","clientState": "null","clientZip": "null","clientPhone": "null","advisorName": "null","advisorTitle": "null","advisorCompanyName": "null","companyAddress1": "null","companyAddress2": "null","companyCity": "null","companyState": "null","companyZip": "null","companyPhone": "null","clientIncome": "0","spouseIncome": "0","clientPayIncreases": "0","spousePayIncreases": "0","clientRetirementAge": "65","spouseRetirementAge": "65","assetValue1": "0","assetValue2": "0","clientDisabilityPension": "0","spouseDisabilityPension": "0","clientDisabilityPensionIndex": "N","spouseDisabilityPensionIndex": "N","clientAge": "null","spouseAge": "null","disabilityCompany1": "null","disabilityPremium1": "0","disabilityInsured1": "Client","disabilityBenefit1": "0","disabilityWaiting1": "0","disabilityBenefitYears1": "0","disabilityMaximumAge1": "0","disabilityIndexed1": "N","disabilityCompany2": "null","disabilityPremium2": "0","disabilityInsured2": "Client","disabilityBenefit2": "0","disabilityWaiting2": "0","disabilityBenefitYears2": "0","disabilityMaximumAge2": "0","disabilityIndexed2": "N","disabilityCompany3": "null","disabilityPremium3": "0","disabilityInsured3": "Client","disabilityBenefit3": "0","disabilityWaiting3": "0","disabilityBenefitYears3": "0","disabilityMaximumAge3": "0","disabilityIndexed3": "N","disabilityCompany4": "null","disabilityPremium4": "0","disabilityInsured4": "Client","disabilityBenefit4": "0","disabilityWaiting4": "0","disabilityBenefitYears4": "0","disabilityMaximumAge4": "0","disabilityIndexed4": "N","clientSpending1": "0","clientSpending1Years": "0","clientSpending2": "0","clientSpending2Years": "0","spouseSpending1": "0","spouseSpending1Years": "0","spouseSpending2": "0","spouseSpending2Years": "0","spouseIncomeChange": "0","clientIncomeChange": "0","child1Age": "0","child2Age": "0","child3Age": "0","child4Age": "0","child5Age": "0","child6Age": "0","preRetirementReturn": ".08","combinedMarginalTaxRate": ".25","inflation": ".03","color1": "null","color2": "null","color3": "null","color4": "null","color5": "null","color6": "null","disclaimer1": "null","disclaimer2": "null","disclaimer3": "null","disclaimer4": "null","ppid": "null","moduleTitle": "null"}

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

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

Description Of Shared Request Elements

username - Provided by CalcXML
password - Provided by CalcXML
responseType - While there are various responseTypes, the only two that really make sense for REST integrations are raw and raw2. raw2 includes result paragraphs/text where raw does not. 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.

Sample JSON Response

Click Submit to send the JSON request below to be processed. The JSON response will be displayed in a new tab/window. You can modify the JSON request prior to sending it as well.

JSON request