CalcXML REST Web Services - bud08 Calculator

URL

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

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","projectedYears": "5","residence": "0","residenceGrowth": "0","vacation": "0","vacationGrowth": "0","furnishings": "0","furnishingsGrowth": "0","autos": "0","autosGrowth": "0","realEstate": "0","realEstateGrowth": "0","art": "0","artGrowth": "0","stocks": "0","stocksGrowth": "0","varAnnuities": "0","varAnnuitiesGrowth": "0","limitedPartner": "0","limitedPartnerGrowth": "0","business": "0","businessGrowth": "0","fixedAnnuities": "0","fixedAnnuitiesGrowth": "0","trustDeeds": "0","trustDeedsGrowth": "0","otherFixed": "0","otherFixedGrowth": "0","govtBonds": "0","govtBondsGrowth": "0","muniBonds": "0","muniBondsGrowth": "0","corpBonds": "0","corpBondsGrowth": "0","faceCertificates": "0","faceCertificatesGrowth": "0","debtMutuals": "0","debtMutualsGrowth": "0","checking": "0","checkingGrowth": "0","savings": "0","savingsGrowth": "0","moneyMarket": "0","moneyMarketGrowth": "0","cd": "0","cdGrowth": "0","otherCash": "0","otherCashGrowth": "0","homeMortgage": "0","homeMortgageGrowth": "0","otherMortgage": "0","otherMortgageGrowth": "0","autoLoan": "0","autoLoanGrowth": "0","bankLoan": "0","bankLoanGrowth": "0","personalLoan": "0","personalLoanGrowth": "0","creditCards": "0","creditCardsGrowth": "0","otherDebts": "0","otherDebtsGrowth": "0"}

Minimal JSON Request

Optional elements will be defaulted

{"username": "XXXXXX","password": "XXXXXX","projectedYears": "5","residence": "0","residenceGrowth": "0","vacation": "0","vacationGrowth": "0","furnishings": "0","furnishingsGrowth": "0","autos": "0","autosGrowth": "0","realEstate": "0","realEstateGrowth": "0","art": "0","artGrowth": "0","stocks": "0","stocksGrowth": "0","varAnnuities": "0","varAnnuitiesGrowth": "0","limitedPartner": "0","limitedPartnerGrowth": "0","business": "0","businessGrowth": "0","fixedAnnuities": "0","fixedAnnuitiesGrowth": "0","trustDeeds": "0","trustDeedsGrowth": "0","otherFixed": "0","otherFixedGrowth": "0","govtBonds": "0","govtBondsGrowth": "0","muniBonds": "0","muniBondsGrowth": "0","corpBonds": "0","corpBondsGrowth": "0","faceCertificates": "0","faceCertificatesGrowth": "0","debtMutuals": "0","debtMutualsGrowth": "0","checking": "0","checkingGrowth": "0","savings": "0","savingsGrowth": "0","moneyMarket": "0","moneyMarketGrowth": "0","cd": "0","cdGrowth": "0","otherCash": "0","otherCashGrowth": "0","homeMortgage": "0","homeMortgageGrowth": "0","otherMortgage": "0","otherMortgageGrowth": "0","autoLoan": "0","autoLoanGrowth": "0","bankLoan": "0","bankLoanGrowth": "0","personalLoan": "0","personalLoanGrowth": "0","creditCards": "0","creditCardsGrowth": "0","otherDebts": "0","otherDebtsGrowth": "0"}

Description Of Calculator-Specific Request Elements

projectedYears Data type: xs:integer Valid values: 1 to 120
residence Data type: xs:double Valid values: 0 to 999999999
residenceGrowth 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
furnishings Data type: xs:double Valid values: 0 to 999999999
furnishingsGrowth Data type: xs:float Valid values: -.12 to .12
autos Data type: xs:double Valid values: 0 to 999999999
autosGrowth Data type: xs:float Valid values: -.12 to .12
realEstate Data type: xs:double Valid values: 0 to 999999999
realEstateGrowth Data type: xs:float Valid values: -.12 to .12
art Data type: xs:double Valid values: 0 to 999999999
artGrowth Data type: xs:float Valid values: -.12 to .12
stocks Data type: xs:double Valid values: 0 to 999999999
stocksGrowth Data type: xs:float Valid values: -.12 to .12
varAnnuities Data type: xs:double Valid values: 0 to 999999999
varAnnuitiesGrowth Data type: xs:float Valid values: -.12 to .12
limitedPartner Data type: xs:double Valid values: 0 to 999999999
limitedPartnerGrowth Data type: xs:float Valid values: -.12 to .12
business Data type: xs:double Valid values: 0 to 999999999
businessGrowth Data type: xs:float Valid values: -.12 to .12
fixedAnnuities Data type: xs:double Valid values: 0 to 999999999
fixedAnnuitiesGrowth Data type: xs:float Valid values: -.12 to .12
trustDeeds Data type: xs:double Valid values: 0 to 999999999
trustDeedsGrowth Data type: xs:float Valid values: -.12 to .12
otherFixed Data type: xs:double Valid values: 0 to 999999999
otherFixedGrowth Data type: xs:float Valid values: -.12 to .12
govtBonds Data type: xs:double Valid values: 0 to 999999999
govtBondsGrowth Data type: xs:float Valid values: -.12 to .12
muniBonds Data type: xs:double Valid values: 0 to 999999999
muniBondsGrowth Data type: xs:float Valid values: -.12 to .12
corpBonds Data type: xs:double Valid values: 0 to 999999999
corpBondsGrowth Data type: xs:float Valid values: -.12 to .12
faceCertificates Data type: xs:double Valid values: 0 to 999999999
faceCertificatesGrowth Data type: xs:float Valid values: -.12 to .12
debtMutuals Data type: xs:double Valid values: 0 to 999999999
debtMutualsGrowth Data type: xs:float Valid values: -.12 to .12
checking Data type: xs:double Valid values: 0 to 999999999
checkingGrowth Data type: xs:float Valid values: -.12 to .12
savings Data type: xs:double Valid values: 0 to 999999999
savingsGrowth Data type: xs:float Valid values: -.12 to .12
moneyMarket Data type: xs:double Valid values: 0 to 999999999
moneyMarketGrowth Data type: xs:float Valid values: -.12 to .12
cd Data type: xs:double Valid values: 0 to 999999999
cdGrowth Data type: xs:float Valid values: -.12 to .12
otherCash Data type: xs:double Valid values: 0 to 999999999
otherCashGrowth Data type: xs:float Valid values: -.12 to .12
homeMortgage Data type: xs:double Valid values: 0 to 999999999
homeMortgageGrowth Data type: xs:float Valid values: -.12 to .12
otherMortgage Data type: xs:double Valid values: 0 to 999999999
otherMortgageGrowth 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
bankLoan Data type: xs:double Valid values: 0 to 999999999
bankLoanGrowth Data type: xs:float Valid values: -.12 to .12
personalLoan Data type: xs:double Valid values: 0 to 999999999
personalLoanGrowth Data type: xs:float Valid values: -.12 to .12
creditCards Data type: xs:double Valid values: 0 to 999999999
creditCardsGrowth Data type: xs:float Valid values: -.12 to .12
otherDebts Data type: xs:double Valid values: 0 to 999999999
otherDebtsGrowth Data type: xs:float Valid values: -.12 to .12

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

Description Of Shared Request Elements

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.

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