Field Search API
API change historyThe Field Search API is an OData service to search Agrimetrics fields. For more details see the introduction to the API.
fields
Search for fields matching a filter and select information to be returned.
Note: The result set on a trial access is limited to 100 fields and to a 30 x 30 km square area defined by the following GeoJSON polygon:
{ 'type': 'Polygon', 'coordinates':[ [ [ -0.370400, 52.093330 ], [ -0.380141, 51.823719 ], [ 0.054878, 51.816921 ], [ 0.067239, 52.086470 ], [ -0.370400, 52.093330 ] ] ] }Try it
Request
Request URL
Request parameters
-
(optional)string
OData filter, for example: $filter=Field/hasAltitude/value eq 20
-
(optional)string
OData select, for example: $select=Field/SoilLayer
-
(optional)integer
OData pagination: The number of hits to be included in the result; default 100
-
(optional)integer
OData pagination: The number of hits that are to be skipped and not included in the result; default 0
-
(optional)integer
Number of days of historical weather to return. Only applicable for daily weather information, such as hasDailyTotalRainfall, and hasDailyMaximumTemperature
-
(optional)boolean
Switch batching on: Receive large results sets in batches of 100 for a given query; default false. Once switched on, the Batch ID for use in subsequent calls is returned in the X-BatchId header.
Request headers
-
(optional)string
Request next batch: Once the batch api has been initiated, pass the returned X-BatchId in subsequent calls to receive the next batch. Continue calling until the results set is empty. Do not supply X-BatchId when starting a new query.
Request body
Responses
200 OK
Field Search
Response headers
-
(optional)string
The batch id: returned when batching.
Representations
{
"results": [
{
"@id": "string",
"@type": "Field"
}
],
"@context": "string"
}
{
"type": "object",
"properties": {
"results": {
"type": "array",
"description": "An array of fields",
"items": {
"type": "object",
"properties": {
"@id": {
"type": "string",
"description": "Field identifier",
"format": "uri"
},
"@type": {
"type": "string",
"description": "Ontology type",
"format": "uri",
"example": "Field"
}
}
}
},
"@context": {
"type": "string",
"description": "Link to field JSON-LD context",
"format": "uri"
}
}
}
400 Bad Request
Bad OData request
Representations
{
"statusCode": 0.0,
"message": "string"
}
{
"type": "object",
"properties": {
"statusCode": {
"type": "number",
"description": "HTTP error code"
},
"message": {
"type": "string",
"description": "Developer friendly error message"
}
}
}
Code samples
@ECHO OFF
curl -v -X GET "https://api.agrimetrics.co.uk/field-search/v1/?$filter={string}&$select={string}&$top={integer}&$skip={integer}&daysOfHistoricalWeather={integer}&batch={boolean}"
-H "X-BatchId: "
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("X-BatchId", "");
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request parameters
queryString["$filter"] = "{string}";
queryString["$select"] = "{string}";
queryString["$top"] = "{integer}";
queryString["$skip"] = "{integer}";
queryString["daysOfHistoricalWeather"] = "{integer}";
queryString["batch"] = "{boolean}";
var uri = "https://api.agrimetrics.co.uk/field-search/v1/?" + queryString;
var response = await client.GetAsync(uri);
}
}
}
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://api.agrimetrics.co.uk/field-search/v1/");
builder.setParameter("$filter", "{string}");
builder.setParameter("$select", "{string}");
builder.setParameter("$top", "{integer}");
builder.setParameter("$skip", "{integer}");
builder.setParameter("daysOfHistoricalWeather", "{integer}");
builder.setParameter("batch", "{boolean}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("X-BatchId", "");
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
"$filter": "{string}",
"$select": "{string}",
"$top": "{integer}",
"$skip": "{integer}",
"daysOfHistoricalWeather": "{integer}",
"batch": "{boolean}",
};
$.ajax({
url: "https://api.agrimetrics.co.uk/field-search/v1/?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("X-BatchId","");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://api.agrimetrics.co.uk/field-search/v1/";
NSArray* array = @[
// Request parameters
@"entities=true",
@"$filter={string}",
@"$select={string}",
@"$top={integer}",
@"$skip={integer}",
@"daysOfHistoricalWeather={integer}",
@"batch={boolean}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"" forHTTPHeaderField:@"X-BatchId"];
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://api.agrimetrics.co.uk/field-search/v1/');
$url = $request->getUrl();
$headers = array(
// Request headers
'X-BatchId' => '',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'$filter' => '{string}',
'$select' => '{string}',
'$top' => '{integer}',
'$skip' => '{integer}',
'daysOfHistoricalWeather' => '{integer}',
'batch' => '{boolean}',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>
########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'X-BatchId': '',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'$filter': '{string}',
'$select': '{string}',
'$top': '{integer}',
'$skip': '{integer}',
'daysOfHistoricalWeather': '{integer}',
'batch': '{boolean}',
})
try:
conn = httplib.HTTPSConnection('api.agrimetrics.co.uk')
conn.request("GET", "/field-search/v1/?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'X-BatchId': '',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'$filter': '{string}',
'$select': '{string}',
'$top': '{integer}',
'$skip': '{integer}',
'daysOfHistoricalWeather': '{integer}',
'batch': '{boolean}',
})
try:
conn = http.client.HTTPSConnection('api.agrimetrics.co.uk')
conn.request("GET", "/field-search/v1/?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
require 'net/http'
uri = URI('https://api.agrimetrics.co.uk/field-search/v1/')
query = URI.encode_www_form({
# Request parameters
'$filter' => '{string}',
'$select' => '{string}',
'$top' => '{integer}',
'$skip' => '{integer}',
'daysOfHistoricalWeather' => '{integer}',
'batch' => '{boolean}'
})
if query.length > 0
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['X-BatchId'] = ''
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body