CalcXML REST Web Services - bud10 Calculator

URL

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

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","mode": "1","projectedYears": "5","wages": "0","wagesGrowth": "0","alimony": "0","alimonyGrowth": "0","dividends": "0","dividendsGrowth": "0","interest": "0","interestGrowth": "0","socialsecurity": "0","socialsecurityGrowth": "0","pensions": "0","pensionsGrowth": "0","otherincome": "0","otherincomeGrowth": "0","mortgage": "0","mortgageGrowth": "0","vacation": "0","vacationGrowth": "0","autoloan": "0","autoloanGrowth": "0","persloan": "0","persloanGrowth": "0","cc": "0","ccGrowth": "0","fedtaxes": "0","fedtaxesGrowth": "0","statetaxes": "0","statetaxesGrowth": "0","fica": "0","ficaGrowth": "0","retaxes": "0","retaxesGrowth": "0","othertaxes": "0","othertaxesGrowth": "0","utilities": "0","utilitiesGrowth": "0","repairs": "0","repairsGrowth": "0","food": "0","foodGrowth": "0","clothing": "0","clothingGrowth": "0","education": "0","educationGrowth": "0","childcare": "0","childcareGrowth": "0","autoexp": "0","autoexpGrowth": "0","transexp": "0","transexpGrowth": "0","lifeins": "0","lifeinsGrowth": "0","homeowners": "0","homeownersGrowth": "0","autoins": "0","autoinsGrowth": "0","medical": "0","medicalGrowth": "0","entertain": "0","entertainGrowth": "0","travel": "0","travelGrowth": "0","club": "0","clubGrowth": "0","hobbies": "0","hobbiesGrowth": "0","gifts": "0","giftsGrowth": "0","homeimp": "0","homeimpGrowth": "0","services": "0","servicesGrowth": "0","charity": "0","charityGrowth": "0","other": "0","otherGrowth": "0"}

Minimal JSON Request

Optional elements will be defaulted

{"username": "XXXXXX","password": "XXXXXX","mode": "1","projectedYears": "5","wages": "0","wagesGrowth": "0","alimony": "0","alimonyGrowth": "0","dividends": "0","dividendsGrowth": "0","interest": "0","interestGrowth": "0","socialsecurity": "0","socialsecurityGrowth": "0","pensions": "0","pensionsGrowth": "0","otherincome": "0","otherincomeGrowth": "0","mortgage": "0","mortgageGrowth": "0","vacation": "0","vacationGrowth": "0","autoloan": "0","autoloanGrowth": "0","persloan": "0","persloanGrowth": "0","cc": "0","ccGrowth": "0","fedtaxes": "0","fedtaxesGrowth": "0","statetaxes": "0","statetaxesGrowth": "0","fica": "0","ficaGrowth": "0","retaxes": "0","retaxesGrowth": "0","othertaxes": "0","othertaxesGrowth": "0","utilities": "0","utilitiesGrowth": "0","repairs": "0","repairsGrowth": "0","food": "0","foodGrowth": "0","clothing": "0","clothingGrowth": "0","education": "0","educationGrowth": "0","childcare": "0","childcareGrowth": "0","autoexp": "0","autoexpGrowth": "0","transexp": "0","transexpGrowth": "0","lifeins": "0","lifeinsGrowth": "0","homeowners": "0","homeownersGrowth": "0","autoins": "0","autoinsGrowth": "0","medical": "0","medicalGrowth": "0","entertain": "0","entertainGrowth": "0","travel": "0","travelGrowth": "0","club": "0","clubGrowth": "0","hobbies": "0","hobbiesGrowth": "0","gifts": "0","giftsGrowth": "0","homeimp": "0","homeimpGrowth": "0","services": "0","servicesGrowth": "0","charity": "0","charityGrowth": "0","other": "0","otherGrowth": "0"}

Description Of Calculator-Specific Request Elements

mode Data type: xs:integer Valid values: 0 (Monthly), 1 (Annual)
projectedYears Data type: xs:integer Valid values: 1 to 120
wages Data type: xs:double Valid values: 0 to 999999999
wagesGrowth Data type: xs:float Valid values: -.12 to .12
alimony Data type: xs:double Valid values: 0 to 999999999
alimonyGrowth Data type: xs:float Valid values: -.12 to .12
dividends Data type: xs:double Valid values: 0 to 999999999
dividendsGrowth Data type: xs:float Valid values: -.12 to .12
interest Data type: xs:double Valid values: 0 to 999999999
interestGrowth Data type: xs:float Valid values: -.12 to .12
socialsecurity Data type: xs:double Valid values: 0 to 999999999
socialsecurityGrowth Data type: xs:float Valid values: -.12 to .12
pensions Data type: xs:double Valid values: 0 to 999999999
pensionsGrowth Data type: xs:float Valid values: -.12 to .12
otherincome Data type: xs:double Valid values: 0 to 999999999
otherincomeGrowth Data type: xs:float Valid values: -.12 to .12
mortgage Data type: xs:double Valid values: 0 to 999999999
mortgageGrowth Data type: xs:float Valid values: -.12 to .12
vacation Data type: xs:double Valid values: 0 to 999999999
vacationGrowth Data type: xs:float Valid values: -.12 to .12
autoloan Data type: xs:double Valid values: 0 to 999999999
autoloanGrowth Data type: xs:float Valid values: -.12 to .12
persloan Data type: xs:double Valid values: 0 to 999999999
persloanGrowth Data type: xs:float Valid values: -.12 to .12
cc Data type: xs:double Valid values: 0 to 999999999
ccGrowth Data type: xs:float Valid values: -.12 to .12
fedtaxes Data type: xs:double Valid values: 0 to 999999999
fedtaxesGrowth Data type: xs:float Valid values: -.12 to .12
statetaxes Data type: xs:double Valid values: 0 to 999999999
statetaxesGrowth Data type: xs:float Valid values: -.12 to .12
fica Data type: xs:double Valid values: 0 to 999999999
ficaGrowth Data type: xs:float Valid values: -.12 to .12
retaxes Data type: xs:double Valid values: 0 to 999999999
retaxesGrowth Data type: xs:float Valid values: -.12 to .12
othertaxes Data type: xs:double Valid values: 0 to 999999999
othertaxesGrowth Data type: xs:float Valid values: -.12 to .12
utilities Data type: xs:double Valid values: 0 to 999999999
utilitiesGrowth Data type: xs:float Valid values: -.12 to .12
repairs Data type: xs:double Valid values: 0 to 999999999
repairsGrowth Data type: xs:float Valid values: -.12 to .12
food Data type: xs:double Valid values: 0 to 999999999
foodGrowth Data type: xs:float Valid values: -.12 to .12
clothing Data type: xs:double Valid values: 0 to 999999999
clothingGrowth Data type: xs:float Valid values: -.12 to .12
education Data type: xs:double Valid values: 0 to 999999999
educationGrowth Data type: xs:float Valid values: -.12 to .12
childcare Data type: xs:double Valid values: 0 to 999999999
childcareGrowth Data type: xs:float Valid values: -.12 to .12
autoexp Data type: xs:double Valid values: 0 to 999999999
autoexpGrowth Data type: xs:float Valid values: -.12 to .12
transexp Data type: xs:double Valid values: 0 to 999999999
transexpGrowth Data type: xs:float Valid values: -.12 to .12
lifeins Data type: xs:double Valid values: 0 to 999999999
lifeinsGrowth Data type: xs:float Valid values: -.12 to .12
homeowners Data type: xs:double Valid values: 0 to 999999999
homeownersGrowth Data type: xs:float Valid values: -.12 to .12
autoins Data type: xs:double Valid values: 0 to 999999999
autoinsGrowth Data type: xs:float Valid values: -.12 to .12
medical Data type: xs:double Valid values: 0 to 999999999
medicalGrowth Data type: xs:float Valid values: -.12 to .12
entertain Data type: xs:double Valid values: 0 to 999999999
entertainGrowth Data type: xs:float Valid values: -.12 to .12
travel Data type: xs:double Valid values: 0 to 999999999
travelGrowth Data type: xs:float Valid values: -.12 to .12
club Data type: xs:double Valid values: 0 to 999999999
clubGrowth Data type: xs:float Valid values: -.12 to .12
hobbies Data type: xs:double Valid values: 0 to 999999999
hobbiesGrowth Data type: xs:float Valid values: -.12 to .12
gifts Data type: xs:double Valid values: 0 to 999999999
giftsGrowth Data type: xs:float Valid values: -.12 to .12
homeimp Data type: xs:double Valid values: 0 to 999999999
homeimpGrowth Data type: xs:float Valid values: -.12 to .12
services Data type: xs:double Valid values: 0 to 999999999
servicesGrowth Data type: xs:float Valid values: -.12 to .12
charity Data type: xs:double Valid values: 0 to 999999999
charityGrowth Data type: xs:float Valid values: -.12 to .12
other Data type: xs:double Valid values: 0 to 999999999
otherGrowth Data type: xs:float Valid values: -.12 to .12

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

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