CalcXML REST Web Services - adv03 Calculator

URL

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

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","clientPayIncrease": "0.03","spousePayIncrease": "0.03","clientRetirementAge": "65","spouseRetirementAge": "65","assetValue1": "0","assetValue2": "0","assetValue3": "0","clientPension": "0","spousePension": "0","clientPensionDeath": "0","spousePensionDeath": "0","clientPensionIncreases": "N","spousePensionIncreases": "N","insuranceAmount1": "0","insuranceAmount2": "0","totalCollegeCosts": "0","debtValue1": "0","debtValue2": "0","funeral": "0","estateAdmin": "0","clientSurvivorsAmount1": "0","clientSurvivorsYears1": "0","clientSurvivorsAmount2": "0","clientSurvivorsYears2": "0","spouseSurvivorsAmount1": "0","spouseSurvivorsYears1": "0","spouseSurvivorsAmount2": "0","spouseSurvivorsYears2": "0","spouseDiesClientEarningsChange": "0","clientDiesSpouseEarningsChange": "0","child1Age": "0","child2Age": "0","child3Age": "0","child4Age": "0","child5Age": "0","child6Age": "0","preRetirementReturn": ".08","preRetirementTaxRate": ".25","inflation": ".03","clientAge": "null","spouseAge": "null","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","clientPayIncrease": "0.03","spousePayIncrease": "0.03","clientRetirementAge": "65","spouseRetirementAge": "65","assetValue1": "0","assetValue2": "0","assetValue3": "0","clientPension": "0","spousePension": "0","clientPensionDeath": "0","spousePensionDeath": "0","clientPensionIncreases": "N","spousePensionIncreases": "N","insuranceAmount1": "0","insuranceAmount2": "0","totalCollegeCosts": "0","debtValue1": "0","debtValue2": "0","funeral": "0","estateAdmin": "0","clientSurvivorsAmount1": "0","clientSurvivorsYears1": "0","clientSurvivorsAmount2": "0","clientSurvivorsYears2": "0","spouseSurvivorsAmount1": "0","spouseSurvivorsYears1": "0","spouseSurvivorsAmount2": "0","spouseSurvivorsYears2": "0","spouseDiesClientEarningsChange": "0","clientDiesSpouseEarningsChange": "0","child1Age": "0","child2Age": "0","child3Age": "0","child4Age": "0","child5Age": "0","child6Age": "0","preRetirementReturn": ".08","preRetirementTaxRate": ".25","inflation": ".03","clientAge": "null","spouseAge": "null","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
clientPayIncrease Data type: xs:float Valid values: 0 to .20
spousePayIncrease 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
assetValue3 Data type: xs:double Valid values: 0 to 999999999
clientPension Data type: xs:double Valid values: 0 to 999999999
spousePension Data type: xs:double Valid values: 0 to 999999999
clientPensionDeath Data type: xs:double Valid values: 0 to 999999999
spousePensionDeath Data type: xs:double Valid values: 0 to 999999999
clientPensionIncreases Data type: xs:string Valid values: N (No), Y (Yes)
spousePensionIncreases Data type: xs:string Valid values: N (No), Y (Yes)
insuranceAmount1 Data type: xs:double Valid values: 0 to 999999999
insuranceAmount2 Data type: xs:double Valid values: 0 to 999999999
totalCollegeCosts Data type: xs:double Valid values: 0 to 999999999
debtValue1 Data type: xs:double Valid values: 0 to 999999999
debtValue2 Data type: xs:double Valid values: 0 to 999999999
funeral Data type: xs:double Valid values: 0 to 999999999
estateAdmin Data type: xs:double Valid values: 0 to 999999999
clientSurvivorsAmount1 Data type: xs:double Valid values: 0 to 999999999
clientSurvivorsYears1 Data type: xs:integer Valid values: 0 to 999999999
clientSurvivorsAmount2 Data type: xs:double Valid values: 0 to 999999999
clientSurvivorsYears2 Data type: xs:integer Valid values: 0 to 999999999
spouseSurvivorsAmount1 Data type: xs:double Valid values: 0 to 999999999
spouseSurvivorsYears1 Data type: xs:integer Valid values: 0 to 999999999
spouseSurvivorsAmount2 Data type: xs:double Valid values: 0 to 999999999
spouseSurvivorsYears2 Data type: xs:integer Valid values: 0 to 999999999
spouseDiesClientEarningsChange Data type: xs:double Valid values: -999999999 to 999999999
clientDiesSpouseEarningsChange 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
preRetirementTaxRate Data type: xs:float Valid values: 0 to .75
inflation Data type: xs:float Valid values: 0 to .10
clientAge Data type: xs:string Valid values: 0 to 999999999
spouseAge 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

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

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