GET v2/crop-types.{ext}?includePrevious={includePrevious}&commodityTypeId={commodityTypeId}

Returns a list of all crop types in the system.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
includePrevious

boolean

Default value is False

commodityTypeId

integer

None.

Body Parameters

None.

Response Information

Resource Description

Collection of CropTypeListItem
NameDescriptionTypeAdditional information
Id

crop type ID

integer

None.

IsPreviousCrop

True if previous crop

boolean

None.

Name

name

string

None.

MaxUptake

max uptake

decimal number

None.

MaxNRec

max N recommendation

decimal number

None.

MaxAge

Max crop age, used for perennial crops

integer

None.

CropMineralizationRate

crop mineralization rate

decimal number

None.

PrevCropK

previous crop K

decimal number

None.

CommodityTypeName

commodity type name

string

None.

BedWidth

decimal number

None.

Rows

decimal number

None.

Response Formats

application/json, text/json, text/html

Sample:
[
  {
    "Id": 1,
    "IsPreviousCrop": true,
    "Name": "sample string 3",
    "MaxUptake": 1.0,
    "MaxNRec": 4.0,
    "MaxAge": 5,
    "CropMineralizationRate": 6.0,
    "PrevCropK": 7.0,
    "CommodityTypeName": "sample string 8",
    "BedWidth": 1.0,
    "Rows": 1.0
  },
  {
    "Id": 1,
    "IsPreviousCrop": true,
    "Name": "sample string 3",
    "MaxUptake": 1.0,
    "MaxNRec": 4.0,
    "MaxAge": 5,
    "CropMineralizationRate": 6.0,
    "PrevCropK": 7.0,
    "CommodityTypeName": "sample string 8",
    "BedWidth": 1.0,
    "Rows": 1.0
  }
]

application/xml, text/xml

Sample:
<ArrayOfCropTypeListItem xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CropTypeListItem>
    <Id>1</Id>
    <IsPreviousCrop>true</IsPreviousCrop>
    <Name>sample string 3</Name>
    <MaxUptake>1</MaxUptake>
    <MaxNRec>4</MaxNRec>
    <MaxAge>5</MaxAge>
    <CropMineralizationRate>6</CropMineralizationRate>
    <PrevCropK>7</PrevCropK>
    <CommodityTypeName>sample string 8</CommodityTypeName>
    <BedWidth>1</BedWidth>
    <Rows>1</Rows>
  </CropTypeListItem>
  <CropTypeListItem>
    <Id>1</Id>
    <IsPreviousCrop>true</IsPreviousCrop>
    <Name>sample string 3</Name>
    <MaxUptake>1</MaxUptake>
    <MaxNRec>4</MaxNRec>
    <MaxAge>5</MaxAge>
    <CropMineralizationRate>6</CropMineralizationRate>
    <PrevCropK>7</PrevCropK>
    <CommodityTypeName>sample string 8</CommodityTypeName>
    <BedWidth>1</BedWidth>
    <Rows>1</Rows>
  </CropTypeListItem>
</ArrayOfCropTypeListItem>