GET api/field/siteclass_item/{soiltypeid}/{altitude}/{postcode}

Site Class of field

Request Information

Authorization is required

Response Codes

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

URI Parameters

NameDescriptionTypeAdditional information
soiltypeid

The Soil Type ID

integer

Required

altitude

The Altitude of the field

integer

Required

postcode

First half of postcode, eg: AB12

string

Required

Body Parameters

None.

Response Information

Resource Description

Returns Site Class of the field

siteclass
NameDescriptionTypeAdditional information
SiteClassID

The ID value for a Site Class item

integer

None.

SiteClassName

The Text value for a Site Class item

string

None.

Response Formats

application/json, text/json

Sample:
{
  "SiteClassID": 1,
  "SiteClassName": "sample string 2"
}

application/xml, text/xml

Sample:
<siteclass xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RB209_WebApi.Models.Field">
  <SiteClassID>1</SiteClassID>
  <SiteClassName>sample string 2</SiteClassName>
</siteclass>