CalcXML REST Web Services - cus28 Calculator

URL

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

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","state": "UT","earnings1": "0","earnings2": "0","file1": "M","file2": "M","allow1": "2","allow2": "2","fedExtras1": "0","fedExtras2": "0","medical1": "0","dental1": "0","basicLife1": "0","add1": "0","healthCare1": "0","vision1": "0","otherPreTax1": "0","ltd1": "0","eeLife1": "0","spouseLife1": "0","childLife1": "0","loan1": "0","legal1": "0","other1": "0","reimburse1": "0","kcont1": "0","kcont2": "0","bcont1": "0","bcont2": "0","bcontAmt1": "0","bcontAmt2": "0","ocont1": "0","ocont2": "0","ocontAmt1": "0","ocontAmt2": "0","rothKAmt1": "0","rothKAmt2": "0"}

Minimal JSON Request

Optional elements will be defaulted

{"username": "XXXXXX","password": "XXXXXX","state": "UT","earnings1": "0","earnings2": "0","file1": "M","file2": "M","allow1": "2","allow2": "2","fedExtras1": "0","fedExtras2": "0","medical1": "0","dental1": "0","basicLife1": "0","add1": "0","healthCare1": "0","vision1": "0","otherPreTax1": "0","ltd1": "0","eeLife1": "0","spouseLife1": "0","childLife1": "0","loan1": "0","legal1": "0","other1": "0","reimburse1": "0","kcont1": "0","kcont2": "0","bcont1": "0","bcont2": "0","bcontAmt1": "0","bcontAmt2": "0","ocont1": "0","ocont2": "0","ocontAmt1": "0","ocontAmt2": "0","rothKAmt1": "0","rothKAmt2": "0"}

Description Of Calculator-Specific Request Elements

state Data type: xs:string Valid values: UT (Utah), ID (Idaho), NV (Nevada), WY (Wyoming)
earnings1 Data type: xs:double Valid values: 0 to 99999999
earnings2 Data type: xs:double Valid values: 0 to 99999999
file1 Data type: xs:string Valid values: M (Married), S (Single)
file2 Data type: xs:string Valid values: M (Married), S (Single)
allow1 Data type: xs:integer Valid values: 0 to 999
allow2 Data type: xs:integer Valid values: 0 to 999
fedExtras1 Data type: xs:double Valid values: 0 to 999999999
fedExtras2 Data type: xs:double Valid values: 0 to 999999999
medical1 Data type: xs:double Valid values: 0 to 999999999
dental1 Data type: xs:double Valid values: 0 to 999999999
basicLife1 Data type: xs:double Valid values: 0 to 999999999
add1 Data type: xs:double Valid values: 0 to 999999999
healthCare1 Data type: xs:double Valid values: 0 to 999999999
vision1 Data type: xs:double Valid values: 0 to 999999999
otherPreTax1 Data type: xs:double Valid values: 0 to 999999999
ltd1 Data type: xs:double Valid values: 0 to 999999999
eeLife1 Data type: xs:double Valid values: 0 to 999999999
spouseLife1 Data type: xs:double Valid values: 0 to 999999999
childLife1 Data type: xs:double Valid values: 0 to 999999999
loan1 Data type: xs:double Valid values: 0 to 999999999
legal1 Data type: xs:double Valid values: 0 to 999999999
other1 Data type: xs:double Valid values: 0 to 999999999
reimburse1 Data type: xs:double Valid values: 0 to 999999999
kcont1 Data type: xs:float Valid values: 0 to 1
kcont2 Data type: xs:float Valid values: 0 to 1
bcont1 Data type: xs:float Valid values: 0 to 1
bcont2 Data type: xs:float Valid values: 0 to 1
bcontAmt1 Data type: xs:double Valid values: 0 to 999999999
bcontAmt2 Data type: xs:double Valid values: 0 to 999999999
ocont1 Data type: xs:float Valid values: 0 to 1
ocont2 Data type: xs:float Valid values: 0 to 1
ocontAmt1 Data type: xs:double Valid values: 0 to 999999999
ocontAmt2 Data type: xs:double Valid values: 0 to 999999999
rothKAmt1 Data type: xs:float Valid values: 0 to 1
rothKAmt2 Data type: xs:float Valid values: 0 to 1

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

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