CalcXML REST Web Services - col07 Calculator

URL

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

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","years": "0","inflationRate": "0","mosRecurring": "9","cellphone1": "0","cellphone2": "0","cellphone3": "0","clothing1": "0","clothing2": "0","clothing3": "0","fees1": "0","fees2": "0","fees3": "0","computer1": "0","computer2": "0","computer3": "0","entertainment1": "0","entertainment2": "0","entertainment3": "0","meals1": "0","meals2": "0","meals3": "0","snacks1": "0","snacks2": "0","snacks3": "0","furnishingsone1": "0","furnishingsone2": "0","furnishingsone3": "0","furnishingsmany1": "0","furnishingsmany2": "0","furnishingsmany3": "0","health1": "0","health2": "0","health3": "0","cable1": "0","cable2": "0","cable3": "0","rentins1": "0","rentins2": "0","rentins3": "0","utilities1": "0","utilities2": "0","utilities3": "0","rent1": "0","rent2": "0","rent3": "0","housedeposit1": "0","housedeposit2": "0","housedeposit3": "0","internet1": "0","internet2": "0","internet3": "0","laundry1": "0","laundry2": "0","laundry3": "0","membership1": "0","membership2": "0","membership3": "0","parking1": "0","parking2": "0","parking3": "0","personal1": "0","personal2": "0","personal3": "0","phone1": "0","phone2": "0","phone3": "0","gas1": "0","gas2": "0","gas3": "0","autoins1": "0","autoins2": "0","autoins3": "0","automaint1": "0","automaint2": "0","automaint3": "0","autopayments1": "0","autopayments2": "0","autopayments3": "0","travel1": "0","travel2": "0","travel3": "0","utilityDeposit1": "0","utilityDeposit2": "0","utilityDeposit3": "0"}

Minimal JSON Request

Optional elements will be defaulted

{"username": "XXXXXX","password": "XXXXXX","years": "0","inflationRate": "0","mosRecurring": "9","cellphone1": "0","cellphone2": "0","cellphone3": "0","clothing1": "0","clothing2": "0","clothing3": "0","fees1": "0","fees2": "0","fees3": "0","computer1": "0","computer2": "0","computer3": "0","entertainment1": "0","entertainment2": "0","entertainment3": "0","meals1": "0","meals2": "0","meals3": "0","snacks1": "0","snacks2": "0","snacks3": "0","furnishingsone1": "0","furnishingsone2": "0","furnishingsone3": "0","furnishingsmany1": "0","furnishingsmany2": "0","furnishingsmany3": "0","health1": "0","health2": "0","health3": "0","cable1": "0","cable2": "0","cable3": "0","rentins1": "0","rentins2": "0","rentins3": "0","utilities1": "0","utilities2": "0","utilities3": "0","rent1": "0","rent2": "0","rent3": "0","housedeposit1": "0","housedeposit2": "0","housedeposit3": "0","internet1": "0","internet2": "0","internet3": "0","laundry1": "0","laundry2": "0","laundry3": "0","membership1": "0","membership2": "0","membership3": "0","parking1": "0","parking2": "0","parking3": "0","personal1": "0","personal2": "0","personal3": "0","phone1": "0","phone2": "0","phone3": "0","gas1": "0","gas2": "0","gas3": "0","autoins1": "0","autoins2": "0","autoins3": "0","automaint1": "0","automaint2": "0","automaint3": "0","autopayments1": "0","autopayments2": "0","autopayments3": "0","travel1": "0","travel2": "0","travel3": "0","utilityDeposit1": "0","utilityDeposit2": "0","utilityDeposit3": "0"}

Description Of Calculator-Specific Request Elements

years Data type: xs:integer Valid values: 0 to 10
inflationRate Data type: xs:float Valid values: 0 to .10
mosRecurring Data type: xs:integer Valid values: 1 to 12
cellphone1 Data type: xs:double Valid values: 0 to 999999999
cellphone2 Data type: xs:double Valid values: 0 to 999999999
cellphone3 Data type: xs:double Valid values: 0 to 999999999
clothing1 Data type: xs:double Valid values: 0 to 999999999
clothing2 Data type: xs:double Valid values: 0 to 999999999
clothing3 Data type: xs:double Valid values: 0 to 999999999
fees1 Data type: xs:double Valid values: 0 to 999999999
fees2 Data type: xs:double Valid values: 0 to 999999999
fees3 Data type: xs:double Valid values: 0 to 999999999
computer1 Data type: xs:double Valid values: 0 to 999999999
computer2 Data type: xs:double Valid values: 0 to 999999999
computer3 Data type: xs:double Valid values: 0 to 999999999
entertainment1 Data type: xs:double Valid values: 0 to 999999999
entertainment2 Data type: xs:double Valid values: 0 to 999999999
entertainment3 Data type: xs:double Valid values: 0 to 999999999
meals1 Data type: xs:double Valid values: 0 to 999999999
meals2 Data type: xs:double Valid values: 0 to 999999999
meals3 Data type: xs:double Valid values: 0 to 999999999
snacks1 Data type: xs:double Valid values: 0 to 999999999
snacks2 Data type: xs:double Valid values: 0 to 999999999
snacks3 Data type: xs:double Valid values: 0 to 999999999
furnishingsone1 Data type: xs:double Valid values: 0 to 999999999
furnishingsone2 Data type: xs:double Valid values: 0 to 999999999
furnishingsone3 Data type: xs:double Valid values: 0 to 999999999
furnishingsmany1 Data type: xs:double Valid values: 0 to 999999999
furnishingsmany2 Data type: xs:double Valid values: 0 to 999999999
furnishingsmany3 Data type: xs:double Valid values: 0 to 999999999
health1 Data type: xs:double Valid values: 0 to 999999999
health2 Data type: xs:double Valid values: 0 to 999999999
health3 Data type: xs:double Valid values: 0 to 999999999
cable1 Data type: xs:double Valid values: 0 to 999999999
cable2 Data type: xs:double Valid values: 0 to 999999999
cable3 Data type: xs:double Valid values: 0 to 999999999
rentins1 Data type: xs:double Valid values: 0 to 999999999
rentins2 Data type: xs:double Valid values: 0 to 999999999
rentins3 Data type: xs:double Valid values: 0 to 999999999
utilities1 Data type: xs:double Valid values: 0 to 999999999
utilities2 Data type: xs:double Valid values: 0 to 999999999
utilities3 Data type: xs:double Valid values: 0 to 999999999
rent1 Data type: xs:double Valid values: 0 to 999999999
rent2 Data type: xs:double Valid values: 0 to 999999999
rent3 Data type: xs:double Valid values: 0 to 999999999
housedeposit1 Data type: xs:double Valid values: 0 to 999999999
housedeposit2 Data type: xs:double Valid values: 0 to 999999999
housedeposit3 Data type: xs:double Valid values: 0 to 999999999
internet1 Data type: xs:double Valid values: 0 to 999999999
internet2 Data type: xs:double Valid values: 0 to 999999999
internet3 Data type: xs:double Valid values: 0 to 999999999
laundry1 Data type: xs:double Valid values: 0 to 999999999
laundry2 Data type: xs:double Valid values: 0 to 999999999
laundry3 Data type: xs:double Valid values: 0 to 999999999
membership1 Data type: xs:double Valid values: 0 to 999999999
membership2 Data type: xs:double Valid values: 0 to 999999999
membership3 Data type: xs:double Valid values: 0 to 999999999
parking1 Data type: xs:double Valid values: 0 to 999999999
parking2 Data type: xs:double Valid values: 0 to 999999999
parking3 Data type: xs:double Valid values: 0 to 999999999
personal1 Data type: xs:double Valid values: 0 to 999999999
personal2 Data type: xs:double Valid values: 0 to 999999999
personal3 Data type: xs:double Valid values: 0 to 999999999
phone1 Data type: xs:double Valid values: 0 to 999999999
phone2 Data type: xs:double Valid values: 0 to 999999999
phone3 Data type: xs:double Valid values: 0 to 999999999
gas1 Data type: xs:double Valid values: 0 to 999999999
gas2 Data type: xs:double Valid values: 0 to 999999999
gas3 Data type: xs:double Valid values: 0 to 999999999
autoins1 Data type: xs:double Valid values: 0 to 999999999
autoins2 Data type: xs:double Valid values: 0 to 999999999
autoins3 Data type: xs:double Valid values: 0 to 999999999
automaint1 Data type: xs:double Valid values: 0 to 999999999
automaint2 Data type: xs:double Valid values: 0 to 999999999
automaint3 Data type: xs:double Valid values: 0 to 999999999
autopayments1 Data type: xs:double Valid values: 0 to 999999999
autopayments2 Data type: xs:double Valid values: 0 to 999999999
autopayments3 Data type: xs:double Valid values: 0 to 999999999
travel1 Data type: xs:double Valid values: 0 to 999999999
travel2 Data type: xs:double Valid values: 0 to 999999999
travel3 Data type: xs:double Valid values: 0 to 999999999
utilityDeposit1 Data type: xs:double Valid values: 0 to 999999999
utilityDeposit2 Data type: xs:double Valid values: 0 to 999999999
utilityDeposit3 Data type: xs:double Valid values: 0 to 999999999

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

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