CalcXML REST Web Services - hom01 Calculator

URL

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

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","combinedIncome": "0","childSupport": "0","autoPayments": "0","ccPayments": "0","associationFees": "0","otherObligations": "0","mortgageRate": "0.05","mortgageTerm": "30","downPayment": "0","propertyTaxes": "0","hazardInsurance": "0","frontRatio": "1","backRatio": "1"}

Minimal JSON Request

Optional elements will be defaulted

{"username": "XXXXXX","password": "XXXXXX","combinedIncome": "0","childSupport": "0","autoPayments": "0","ccPayments": "0","associationFees": "0","otherObligations": "0","mortgageRate": "0.05","mortgageTerm": "30","downPayment": "0","propertyTaxes": "0","hazardInsurance": "0","frontRatio": "1","backRatio": "1"}

Description Of Calculator-Specific Request Elements

combinedIncome Data type: xs:double Valid values: 0 to 999999999
childSupport Data type: xs:double Valid values: 0 to 999999999
autoPayments Data type: xs:double Valid values: 0 to 999999999
ccPayments Data type: xs:double Valid values: 0 to 999999999
associationFees Data type: xs:double Valid values: 0 to 999999999
otherObligations Data type: xs:double Valid values: 0 to 999999999
mortgageRate Data type: xs:float Valid values: 0 to .4
mortgageTerm Data type: xs:integer Valid values: 15, 20, 30, 40
downPayment Data type: xs:double Valid values: 0 to 999999999
propertyTaxes Data type: xs:double Valid values: 0 to 999999999
hazardInsurance Data type: xs:double Valid values: 0 to 999999999
frontRatio Data type: xs:float Valid values: 1 (28%), 2 (33%), 3 (36%)
backRatio Data type: xs:float Valid values: 1 (36%), 2 (40%), 3 (45%)

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

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.