CalcXML REST Web Services - det14 Calculator

URL

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

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","creditReportAvail": "Y","creditLength": "0","creditTypes": "","appliedCredit": "0","missedPayment": "0","totalCreditLimit": "0","totalCreditBalance": "0","negativeReport": "N","negativeReportTime": "0"}

Minimal JSON Request

Optional elements will be defaulted

{"username": "XXXXXX","password": "XXXXXX","creditReportAvail": "Y","creditLength": "0","creditTypes": "","appliedCredit": "0","missedPayment": "0","totalCreditLimit": "0","totalCreditBalance": "0","negativeReport": "N","negativeReportTime": "0"}

Description Of Calculator-Specific Request Elements

creditReportAvail Data type: xs:string Valid values: N (No), Y (Yes)
creditLength Data type: xs:integer Valid values: 0 to 120
creditTypes Data type: xs:string Valid values: 0 to 999999999
appliedCredit Data type: xs:integer Valid values: 0 (0 times), 2 (1 or 2 times), 5 (3 to 5 times), 8 (6 to 8 times), 9 (9 times or more)
missedPayment Data type: xs:integer Valid values: 0 (Never), 3 (Less than 3 months ago), 6 (3 to 6 months ago), 12 (6 to 12 months ago), 24 (1 to 2 years ago), 25 (More than 2 year ago)
totalCreditLimit Data type: xs:double Valid values: 0 to 999999999
totalCreditBalance Data type: xs:double Valid values: 0 to 999999999
negativeReport Data type: xs:string Valid values: N (No), Y (Yes)
negativeReportTime Data type: xs:integer Valid values: 0 (No negative events), 3 (Less than 3 months ago), 6 (3 to 6 months ago), 12 (6 to 12 months ago), 24 (1 to 2 years ago), 36 (2 to 3 years ago), 48 (3 to 4 years ago), 60 (4 to 5 years ago), 72 (5 to 6 years ago), 84 (6 to 7 years ago), 96 (7 to 8 years ago), 97 (More than 8 years ago)

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

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.