CalcXML REST Web Services - gar01 Calculator

URL

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

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","unitOfMeasure": "8","dryArugula": "0","frzArugula": "0","canArugula": "0","eatArugula": "0","dryBeansBush": "0","frzBeansBush": "0","canBeansBush": "0","eatBeansBush": "0","dryBeansPole": "0","frzBeansPole": "0","canBeansPole": "0","eatBeansPole": "0","dryBeets": "0","frzBeets": "0","canBeets": "0","eatBeets": "0","dryBroccoli": "0","frzBroccoli": "0","canBroccoli": "0","eatBroccoli": "0","dryBrussel": "0","frzBrussel": "0","canBrussel": "0","eatBrussel": "0","dryCabbage": "0","frzCabbage": "0","canCabbage": "0","eatCabbage": "0","dryCarrots": "0","frzCarrots": "0","canCarrots": "0","eatCarrots": "0","dryCauliflower": "0","frzCauliflower": "0","canCauliflower": "0","eatCauliflower": "0","dryCelery": "0","frzCelery": "0","canCelery": "0","eatCelery": "0","dryChard": "0","frzChard": "0","canChard": "0","eatChard": "0","dryCucumbers": "0","frzCucumbers": "0","canCucumbers": "0","eatCucumbers": "0","dryEggplant": "0","frzEggplant": "0","canEggplant": "0","eatEggplant": "0","dryKale": "0","frzKale": "0","canKale": "0","eatKale": "0","dryKohlrabi": "0","frzKohlrabi": "0","canKohlrabi": "0","eatKohlrabi": "0","dryLeek": "0","frzLeek": "0","canLeek": "0","eatLeek": "0","dryLettuce": "0","frzLettuce": "0","canLettuce": "0","eatLettuce": "0","dryOkra": "0","frzOkra": "0","canOkra": "0","eatOkra": "0","dryOnions": "0","frzOnions": "0","canOnions": "0","eatOnions": "0","dryPeas": "0","frzPeas": "0","canPeas": "0","eatPeas": "0","dryPeppers": "0","frzPeppers": "0","canPeppers": "0","eatPeppers": "0","dryRadish": "0","frzRadish": "0","canRadish": "0","eatRadish": "0","drySpinach": "0","frzSpinach": "0","canSpinach": "0","eatSpinach": "0","drySquashWinter": "0","frzSquashWinter": "0","canSquashWinter": "0","eatSquashWinter": "0","drySquashYellow": "0","frzSquashYellow": "0","canSquashYellow": "0","eatSquashYellow": "0","drySquashZucchini": "0","frzSquashZucchini": "0","canSquashZucchini": "0","eatSquashZucchini": "0","drySweetCorn": "0","frzSweetCorn": "0","canSweetCorn": "0","eatSweetCorn": "0","dryTomatoes": "0","frzTomatoes": "0","canTomatoes": "0","eatTomatoes": "0","dryTurnips": "0","frzTurnips": "0","canTurnips": "0","eatTurnips": "0"}

Minimal JSON Request

Optional elements will be defaulted

{"username": "XXXXXX","password": "XXXXXX","unitOfMeasure": "8","dryArugula": "0","frzArugula": "0","canArugula": "0","eatArugula": "0","dryBeansBush": "0","frzBeansBush": "0","canBeansBush": "0","eatBeansBush": "0","dryBeansPole": "0","frzBeansPole": "0","canBeansPole": "0","eatBeansPole": "0","dryBeets": "0","frzBeets": "0","canBeets": "0","eatBeets": "0","dryBroccoli": "0","frzBroccoli": "0","canBroccoli": "0","eatBroccoli": "0","dryBrussel": "0","frzBrussel": "0","canBrussel": "0","eatBrussel": "0","dryCabbage": "0","frzCabbage": "0","canCabbage": "0","eatCabbage": "0","dryCarrots": "0","frzCarrots": "0","canCarrots": "0","eatCarrots": "0","dryCauliflower": "0","frzCauliflower": "0","canCauliflower": "0","eatCauliflower": "0","dryCelery": "0","frzCelery": "0","canCelery": "0","eatCelery": "0","dryChard": "0","frzChard": "0","canChard": "0","eatChard": "0","dryCucumbers": "0","frzCucumbers": "0","canCucumbers": "0","eatCucumbers": "0","dryEggplant": "0","frzEggplant": "0","canEggplant": "0","eatEggplant": "0","dryKale": "0","frzKale": "0","canKale": "0","eatKale": "0","dryKohlrabi": "0","frzKohlrabi": "0","canKohlrabi": "0","eatKohlrabi": "0","dryLeek": "0","frzLeek": "0","canLeek": "0","eatLeek": "0","dryLettuce": "0","frzLettuce": "0","canLettuce": "0","eatLettuce": "0","dryOkra": "0","frzOkra": "0","canOkra": "0","eatOkra": "0","dryOnions": "0","frzOnions": "0","canOnions": "0","eatOnions": "0","dryPeas": "0","frzPeas": "0","canPeas": "0","eatPeas": "0","dryPeppers": "0","frzPeppers": "0","canPeppers": "0","eatPeppers": "0","dryRadish": "0","frzRadish": "0","canRadish": "0","eatRadish": "0","drySpinach": "0","frzSpinach": "0","canSpinach": "0","eatSpinach": "0","drySquashWinter": "0","frzSquashWinter": "0","canSquashWinter": "0","eatSquashWinter": "0","drySquashYellow": "0","frzSquashYellow": "0","canSquashYellow": "0","eatSquashYellow": "0","drySquashZucchini": "0","frzSquashZucchini": "0","canSquashZucchini": "0","eatSquashZucchini": "0","drySweetCorn": "0","frzSweetCorn": "0","canSweetCorn": "0","eatSweetCorn": "0","dryTomatoes": "0","frzTomatoes": "0","canTomatoes": "0","eatTomatoes": "0","dryTurnips": "0","frzTurnips": "0","canTurnips": "0","eatTurnips": "0"}

Description Of Calculator-Specific Request Elements

unitOfMeasure Data type: xs:integer Valid values: 1 (4oz servings), 2 (Cups), 4 (Pints), 8 (Quarts)
dryArugula Data type: xs:integer Valid values: 0 to 999999999
frzArugula Data type: xs:integer Valid values: 0 to 999999999
canArugula Data type: xs:integer Valid values: 0 to 999999999
eatArugula Data type: xs:integer Valid values: 0 to 999999999
dryBeansBush Data type: xs:integer Valid values: 0 to 999999999
frzBeansBush Data type: xs:integer Valid values: 0 to 999999999
canBeansBush Data type: xs:integer Valid values: 0 to 999999999
eatBeansBush Data type: xs:integer Valid values: 0 to 999999999
dryBeansPole Data type: xs:integer Valid values: 0 to 999999999
frzBeansPole Data type: xs:integer Valid values: 0 to 999999999
canBeansPole Data type: xs:integer Valid values: 0 to 999999999
eatBeansPole Data type: xs:integer Valid values: 0 to 999999999
dryBeets Data type: xs:integer Valid values: 0 to 999999999
frzBeets Data type: xs:integer Valid values: 0 to 999999999
canBeets Data type: xs:integer Valid values: 0 to 999999999
eatBeets Data type: xs:integer Valid values: 0 to 999999999
dryBroccoli Data type: xs:integer Valid values: 0 to 999999999
frzBroccoli Data type: xs:integer Valid values: 0 to 999999999
canBroccoli Data type: xs:integer Valid values: 0 to 999999999
eatBroccoli Data type: xs:integer Valid values: 0 to 999999999
dryBrussel Data type: xs:integer Valid values: 0 to 999999999
frzBrussel Data type: xs:integer Valid values: 0 to 999999999
canBrussel Data type: xs:integer Valid values: 0 to 999999999
eatBrussel Data type: xs:integer Valid values: 0 to 999999999
dryCabbage Data type: xs:integer Valid values: 0 to 999999999
frzCabbage Data type: xs:integer Valid values: 0 to 999999999
canCabbage Data type: xs:integer Valid values: 0 to 999999999
eatCabbage Data type: xs:integer Valid values: 0 to 999999999
dryCarrots Data type: xs:integer Valid values: 0 to 999999999
frzCarrots Data type: xs:integer Valid values: 0 to 999999999
canCarrots Data type: xs:integer Valid values: 0 to 999999999
eatCarrots Data type: xs:integer Valid values: 0 to 999999999
dryCauliflower Data type: xs:integer Valid values: 0 to 999999999
frzCauliflower Data type: xs:integer Valid values: 0 to 999999999
canCauliflower Data type: xs:integer Valid values: 0 to 999999999
eatCauliflower Data type: xs:integer Valid values: 0 to 999999999
dryCelery Data type: xs:integer Valid values: 0 to 999999999
frzCelery Data type: xs:integer Valid values: 0 to 999999999
canCelery Data type: xs:integer Valid values: 0 to 999999999
eatCelery Data type: xs:integer Valid values: 0 to 999999999
dryChard Data type: xs:integer Valid values: 0 to 999999999
frzChard Data type: xs:integer Valid values: 0 to 999999999
canChard Data type: xs:integer Valid values: 0 to 999999999
eatChard Data type: xs:integer Valid values: 0 to 999999999
dryCucumbers Data type: xs:integer Valid values: 0 to 999999999
frzCucumbers Data type: xs:integer Valid values: 0 to 999999999
canCucumbers Data type: xs:integer Valid values: 0 to 999999999
eatCucumbers Data type: xs:integer Valid values: 0 to 999999999
dryEggplant Data type: xs:integer Valid values: 0 to 999999999
frzEggplant Data type: xs:integer Valid values: 0 to 999999999
canEggplant Data type: xs:integer Valid values: 0 to 999999999
eatEggplant Data type: xs:integer Valid values: 0 to 999999999
dryKale Data type: xs:integer Valid values: 0 to 999999999
frzKale Data type: xs:integer Valid values: 0 to 999999999
canKale Data type: xs:integer Valid values: 0 to 999999999
eatKale Data type: xs:integer Valid values: 0 to 999999999
dryKohlrabi Data type: xs:integer Valid values: 0 to 999999999
frzKohlrabi Data type: xs:integer Valid values: 0 to 999999999
canKohlrabi Data type: xs:integer Valid values: 0 to 999999999
eatKohlrabi Data type: xs:integer Valid values: 0 to 999999999
dryLeek Data type: xs:integer Valid values: 0 to 999999999
frzLeek Data type: xs:integer Valid values: 0 to 999999999
canLeek Data type: xs:integer Valid values: 0 to 999999999
eatLeek Data type: xs:integer Valid values: 0 to 999999999
dryLettuce Data type: xs:integer Valid values: 0 to 999999999
frzLettuce Data type: xs:integer Valid values: 0 to 999999999
canLettuce Data type: xs:integer Valid values: 0 to 999999999
eatLettuce Data type: xs:integer Valid values: 0 to 999999999
dryOkra Data type: xs:integer Valid values: 0 to 999999999
frzOkra Data type: xs:integer Valid values: 0 to 999999999
canOkra Data type: xs:integer Valid values: 0 to 999999999
eatOkra Data type: xs:integer Valid values: 0 to 999999999
dryOnions Data type: xs:integer Valid values: 0 to 999999999
frzOnions Data type: xs:integer Valid values: 0 to 999999999
canOnions Data type: xs:integer Valid values: 0 to 999999999
eatOnions Data type: xs:integer Valid values: 0 to 999999999
dryPeas Data type: xs:integer Valid values: 0 to 999999999
frzPeas Data type: xs:integer Valid values: 0 to 999999999
canPeas Data type: xs:integer Valid values: 0 to 999999999
eatPeas Data type: xs:integer Valid values: 0 to 999999999
dryPeppers Data type: xs:integer Valid values: 0 to 999999999
frzPeppers Data type: xs:integer Valid values: 0 to 999999999
canPeppers Data type: xs:integer Valid values: 0 to 999999999
eatPeppers Data type: xs:integer Valid values: 0 to 999999999
dryRadish Data type: xs:integer Valid values: 0 to 999999999
frzRadish Data type: xs:integer Valid values: 0 to 999999999
canRadish Data type: xs:integer Valid values: 0 to 999999999
eatRadish Data type: xs:integer Valid values: 0 to 999999999
drySpinach Data type: xs:integer Valid values: 0 to 999999999
frzSpinach Data type: xs:integer Valid values: 0 to 999999999
canSpinach Data type: xs:integer Valid values: 0 to 999999999
eatSpinach Data type: xs:integer Valid values: 0 to 999999999
drySquashWinter Data type: xs:integer Valid values: 0 to 999999999
frzSquashWinter Data type: xs:integer Valid values: 0 to 999999999
canSquashWinter Data type: xs:integer Valid values: 0 to 999999999
eatSquashWinter Data type: xs:integer Valid values: 0 to 999999999
drySquashYellow Data type: xs:integer Valid values: 0 to 999999999
frzSquashYellow Data type: xs:integer Valid values: 0 to 999999999
canSquashYellow Data type: xs:integer Valid values: 0 to 999999999
eatSquashYellow Data type: xs:integer Valid values: 0 to 999999999
drySquashZucchini Data type: xs:integer Valid values: 0 to 999999999
frzSquashZucchini Data type: xs:integer Valid values: 0 to 999999999
canSquashZucchini Data type: xs:integer Valid values: 0 to 999999999
eatSquashZucchini Data type: xs:integer Valid values: 0 to 999999999
drySweetCorn Data type: xs:integer Valid values: 0 to 999999999
frzSweetCorn Data type: xs:integer Valid values: 0 to 999999999
canSweetCorn Data type: xs:integer Valid values: 0 to 999999999
eatSweetCorn Data type: xs:integer Valid values: 0 to 999999999
dryTomatoes Data type: xs:integer Valid values: 0 to 999999999
frzTomatoes Data type: xs:integer Valid values: 0 to 999999999
canTomatoes Data type: xs:integer Valid values: 0 to 999999999
eatTomatoes Data type: xs:integer Valid values: 0 to 999999999
dryTurnips Data type: xs:integer Valid values: 0 to 999999999
frzTurnips Data type: xs:integer Valid values: 0 to 999999999
canTurnips Data type: xs:integer Valid values: 0 to 999999999
eatTurnips Data type: xs:integer Valid values: 0 to 999999999

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

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.

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