GET api/organicmaterial/organicmaterialtype_list/{organicmaterialcategoryid}/{drymattersplit}

Organic Material Types list filtered by Organic Material Category ID, with option to return materials with seperate dry matter percentages, or just a single general material

Request Information

Authorization is required

Response Codes

OK (200)
BadRequest (400)
Unauthorized (401)
NotFound (404)

URI Parameters

Name	Description	Type	Additional information
organicmaterialcategoryid	The Organic Material Category ID	integer	Required
drymattersplit	To determine whether to return materials that have seperate dry matter percentages or just a single general material	boolean	Required

Body Parameters

None.

Response Information

Resource Description

Returns a list of all available Organic Material Types for the provided Organic Material Category ID

Collection of organicmaterialtype

Name	Description	Type	Additional information
OrganicMaterialTypeID	Organic Material Type ID	integer	None.
OrganicMaterialTypeName	Organic Material Type Name	string	None.
DryMatter	The Dry Matter (%) of the Organic Material	decimal number	None.
TotalN	The Total Nitrogen (kg/Tonne or kg/m3) in the Organic Material	decimal number	None.
TotalP	The Total Phosphate (kg/Tonne or kg/m3) in the Organic Material	decimal number	None.
TotalK	The Total Potash (kg/Tonne or kg/m3) in the Organic Material	decimal number	None.
TotalMg	The Total Magnesium (kg/Tonne or kg/m3) in the Organic Material	decimal number	None.
TotalS	The Total Sulphur (kg/Tonne or kg/m3) in the Organic Material	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "OrganicMaterialTypeID": 1,
    "OrganicMaterialTypeName": "sample string 2",
    "DryMatter": 1.0,
    "TotalN": 1.0,
    "TotalP": 1.0,
    "TotalK": 1.0,
    "TotalMg": 1.0,
    "TotalS": 1.0
  },
  {
    "OrganicMaterialTypeID": 1,
    "OrganicMaterialTypeName": "sample string 2",
    "DryMatter": 1.0,
    "TotalN": 1.0,
    "TotalP": 1.0,
    "TotalK": 1.0,
    "TotalMg": 1.0,
    "TotalS": 1.0
  }
]

application/xml, text/xml

Sample:

<ArrayOforganicmaterialtype xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RB209_WebApi.Models.OrganicMaterial">
  <organicmaterialtype>
    <DryMatter>1</DryMatter>
    <OrganicMaterialTypeID>1</OrganicMaterialTypeID>
    <OrganicMaterialTypeName>sample string 2</OrganicMaterialTypeName>
    <TotalK>1</TotalK>
    <TotalMg>1</TotalMg>
    <TotalN>1</TotalN>
    <TotalP>1</TotalP>
    <TotalS>1</TotalS>
  </organicmaterialtype>
  <organicmaterialtype>
    <DryMatter>1</DryMatter>
    <OrganicMaterialTypeID>1</OrganicMaterialTypeID>
    <OrganicMaterialTypeName>sample string 2</OrganicMaterialTypeName>
    <TotalK>1</TotalK>
    <TotalMg>1</TotalMg>
    <TotalN>1</TotalN>
    <TotalP>1</TotalP>
    <TotalS>1</TotalS>
  </organicmaterialtype>
</ArrayOforganicmaterialtype>