GET api/rainfall/rainfallaverage/{postcode}

Average Rainfall of field

Request Information

Authorization is required

Response Codes

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

URI Parameters

NameDescriptionTypeAdditional information
postcode

First half of postcode, eg: AB12

 string

Required

Body Parameters

None.

Response Information

Resource Description

Using the provided postcode, calculates the average rainfall for the field. Can be used to calculate the RainfallAverage value on the Main Recommendations endpoint.

averagerainfallitem
NameDescriptionTypeAdditional information
AverageRainfall

The Average Rainfall value returned

 decimal number

None.

Response Formats

application/json, text/json

Sample: 
{
  "AverageRainfall": 1.0
}

application/xml, text/xml

Sample: 
<averagerainfallitem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RB209_WebApi.Models.Rainfall">
  <AverageRainfall>1</AverageRainfall>
</averagerainfallitem>