GET v2/commodity-types.json

Returns a complete list of commodity types in CropManage.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of CommodityTypeModel

Name	Description	Type	Additional information
Id	commodity type ID	integer	None.
Name	commodity type name	string	None.
IconPath	commodity type icon path, used in planting settings	string	None.
HarvestOnce	If false, commodity type is harvest multiple times in a season (e.g. strawberry)	boolean	None.
IsActive	In general, commodity types are set to active. If this field is false, commodity type is currently not used by the system.	boolean	None.
CommodityTypeCalculator	string containing the name of the calculator used for recommendation equations.	string	None.

Response Formats

application/json, text/json, text/html

Sample:

[
  {
    "Id": 1,
    "Name": "sample string 2",
    "IconPath": "sample string 3",
    "HarvestOnce": true,
    "IsActive": true,
    "CommodityTypeCalculator": "sample string 6"
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "IconPath": "sample string 3",
    "HarvestOnce": true,
    "IsActive": true,
    "CommodityTypeCalculator": "sample string 6"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCommodityTypeModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CommodityTypeModel>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <IconPath>sample string 3</IconPath>
    <HarvestOnce>true</HarvestOnce>
    <IsActive>true</IsActive>
    <CommodityTypeCalculator>sample string 6</CommodityTypeCalculator>
  </CommodityTypeModel>
  <CommodityTypeModel>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <IconPath>sample string 3</IconPath>
    <HarvestOnce>true</HarvestOnce>
    <IsActive>true</IsActive>
    <CommodityTypeCalculator>sample string 6</CommodityTypeCalculator>
  </CommodityTypeModel>
</ArrayOfCommodityTypeModel>