CalcXML REST Web Services - gar02 Calculator

URL

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

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","arugula": "0","beansBush": "0","beansPole": "0","beets": "0","broccoli": "0","brussel": "0","cabbage": "0","carrots": "0","cauliflower": "0","celery": "0","chard": "0","cucumbers": "0","eggplant": "0","kale": "0","kohlrabi": "0","leek": "0","lettuce": "0","okra": "0","onions": "0","peas": "0","peppers": "0","radish": "0","spinach": "0","squashWinter": "0","squashYellow": "0","squashZucchini": "0","sweetCorn": "0","tomatoes": "0","turnips": "0"}

Minimal JSON Request

Optional elements will be defaulted

{"username": "XXXXXX","password": "XXXXXX","arugula": "0","beansBush": "0","beansPole": "0","beets": "0","broccoli": "0","brussel": "0","cabbage": "0","carrots": "0","cauliflower": "0","celery": "0","chard": "0","cucumbers": "0","eggplant": "0","kale": "0","kohlrabi": "0","leek": "0","lettuce": "0","okra": "0","onions": "0","peas": "0","peppers": "0","radish": "0","spinach": "0","squashWinter": "0","squashYellow": "0","squashZucchini": "0","sweetCorn": "0","tomatoes": "0","turnips": "0"}

Description Of Calculator-Specific Request Elements

arugula Data type: xs:integer Valid values: 0 to 999999999
beansBush Data type: xs:integer Valid values: 0 to 999999999
beansPole Data type: xs:integer Valid values: 0 to 999999999
beets Data type: xs:integer Valid values: 0 to 999999999
broccoli Data type: xs:integer Valid values: 0 to 999999999
brussel Data type: xs:integer Valid values: 0 to 999999999
cabbage Data type: xs:integer Valid values: 0 to 999999999
carrots Data type: xs:integer Valid values: 0 to 999999999
cauliflower Data type: xs:integer Valid values: 0 to 999999999
celery Data type: xs:integer Valid values: 0 to 999999999
chard Data type: xs:integer Valid values: 0 to 999999999
cucumbers Data type: xs:integer Valid values: 0 to 999999999
eggplant Data type: xs:integer Valid values: 0 to 999999999
kale Data type: xs:integer Valid values: 0 to 999999999
kohlrabi Data type: xs:integer Valid values: 0 to 999999999
leek Data type: xs:integer Valid values: 0 to 999999999
lettuce Data type: xs:integer Valid values: 0 to 999999999
okra Data type: xs:integer Valid values: 0 to 999999999
onions Data type: xs:integer Valid values: 0 to 999999999
peas Data type: xs:integer Valid values: 0 to 999999999
peppers Data type: xs:integer Valid values: 0 to 999999999
radish Data type: xs:integer Valid values: 0 to 999999999
spinach Data type: xs:integer Valid values: 0 to 999999999
squashWinter Data type: xs:integer Valid values: 0 to 999999999
squashYellow Data type: xs:integer Valid values: 0 to 999999999
squashZucchini Data type: xs:integer Valid values: 0 to 999999999
sweetCorn Data type: xs:integer Valid values: 0 to 999999999
tomatoes Data type: xs:integer Valid values: 0 to 999999999
turnips Data type: xs:integer Valid values: 0 to 999999999

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

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