GET
/boundaries
List Boundaries
GET
/organizations/{orgID}/boundaries
View Boundaries in an Org
GET
/organizations/{orgID}/boundaries/{id}
View a Boundary
GET
/organizations/{orgID}/fields/{id}/boundaries
View Boundaries of a Field
Become a beta tester for FieldDetails resources.
The term "boundaries" refers to the boundaries of a particular field.
 
Boundary Object Specification
A boundary can be returned on its own, or within a list of boundaries. When returned in a list, each boundary object is inside the boundaries object. The following tables indicate the data included within each boundary object.
 
Name Type minOccurs maxOccurs Default Description
name string 0 1 --- This is the field name.
area measurement AsDouble 0 1 --- This is the area of the boundary.
multipolygon polygon 0 unbounded --- This is a list of polygons.
extent extent 0 1 --- The extent of the boundary (the smallest rectangle that will enclose all of the points forming the boundary).
active boolean false Indicates whether this is the active boundary for the field with which it is associated.
 
Complex Type: Area
Name Type minOccurs maxOccurs Default Description
value double --- 1 --- This is the value for total area.
unit string --- --- --- This is the unit of the area.
 
Complex Type: Polygon
Name Type minOccurs maxOccurs Default Description
rings ring 0 unbounded --- This is a list of rings.
 
Complex Type: Ring
Name Type minOccurs maxOccurs Default Description
points point 0 unbounded --- This is a list of coordinates that make up a ring.
type string --- --- --- This is the type of ring.
passable boolean --- --- true Indicates whether the ring is passable.
GET /boundaries
View Boundaries
View all boundaries. For each data point, the response will include links to the following resources:
  • fields: View the field associated with these boundaries.
  • owningOrganizations: View the organization that owns the field.
 
Request URI
GET: https://apicert.soa-proxy.deere.com/platform/boundaries
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Request Header
Header Key Type Example Description Default Required?
Accept-UOM-System string METRIC Takes METRIC and ENGLISH. Converts measurements to the chosen system. METRIC No.
 
Request Parameter
This endpoint does not currently support any filters/request parameters.
 
Response Details
Field Type Example Description
id string 6232611a-0303-0234-8g7d-e1e1e11871b8 Boundary ID
name string 4/4/2014 1:35:30 PM Boundary name
area --- See sample response below. Boundary area
multipolygons --- See sample response below. Boundary shape and exact location.
type string exterior Boundary type1
passable boolean true "True" indicates that the boundary can be crossed (Ex: a waterway). "False" indicates that the boundary cannot be crossed (ex: a boulder).
extent --- See sample response below. Coordinates of the extent of the boundary.
active boolean true Indicates whether or not the boundary is active.
 
Sample Response [JSON]
200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
   "links": [
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/platform/boundaries"
      }
   ],
   "total": 1,
   "values": [
      {
         "name": "2/25/2015 6:01:19 PM",
         "area": {
            "valueAsDouble": 70.8407,
            "unit": "ha"
         },
         "multipolygons": [
            {
               "rings": [
                  {
                     "points": [
                        {
                           "lat": 41.538383,
                           "lon": -90.81443
                        },
                        {
                           "lat": 41.530777,
                           "lon": -90.81459
                        },
                        {
                           "lat": 41.530895,
                           "lon": -90.82465
                        },
                        {
                           "lat": 41.538517,
                           "lon": -90.82444
                        },
                        {
                           "lat": 41.538383,
                           "lon": -90.81443
                        }
                     ],
                     "type": "exterior",
                     "passable": true
                  }
               ]
            }
         ],
         "extent": {
            "topLeft": {
               "lat": 41.538517,
               "lon": -90.82465
            },
            "bottomRight": {
               "lat": 41.530777,
               "lon": -90.81443
            }
         },
         "links": [
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/boundaries/6232611a-0303-0234-8g7d-e1e1e11871b8"
            },
            {
               "rel": "fields",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/boundaries/6232611a-0303-0234-8g7d-e1e1e11871b8/fields"
            },
            {
               "rel": "owningOrganization",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234"
            }
         ],
         "id": "6232611a-0303-0234-8g7d-e1e1e11871b8",
         "active": "true"
      }
   ]
}
 
[1] Types of Boundaries:  
exterior Outer border of the field.
interior Blocked area inside the field.
GET /organizations/{orgID} /boundaries
View Boundaries in an Org
View boundaries in an organization. The response will include links to the following resources:
  • fields: View the field associated with these boundaries.
  • owningOrganizations: View the organization that owns the field.
 
Request URI
GET: https://apicert.soa-proxy.deere.com/platform/organizations/{orgID}/boundaries
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Request Header
Header Key Type Example Description Default Required?
Accept-UOM-System string METRIC Takes METRIC and ENGLISH. Converts measurements to the chosen system. METRIC No.
 
Request Parameter
This endpoint does not currently support any filters/request parameters.
 
Response Details
Field Type Example Description
id string 6232611a-0303-0234-8g7d-e1e1e11871b8 Boundary ID
name string 4/4/2014 1:35:30 PM Boundary name
Area --- See sample response below. Boundary area
multipolygons --- See sample response below. Boundary shape and exact location.
type string exterior Boundary type1
passable boolean true "True" indicates that the boundary can be crossed (Ex: a waterway). "False" indicates that the boundary cannot be crossed (ex: a boulder).
extent --- See sample response below. Coordinates of the extent of the boundary.
active boolean true Indicates whether or not the boundary is active.
 
Sample Response [JSON]
200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
   "links": [
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/platform/organizations/1234/boundaries"
      }
   ],
   "total": 1,
   "values": [
      {
         "name": "2/25/2015 6:01:19 PM",
         "area": {
            "valueAsDouble": 70.8407,
            "unit": "ha"
         },
         "multipolygons": [
            {
               "rings": [
                  {
                     "points": [
                        {
                           "lat": 41.538383,
                           "lon": -90.81443
                        },
                        {
                           "lat": 41.530777,
                           "lon": -90.81459
                        },
                        {
                           "lat": 41.530895,
                           "lon": -90.82465
                        },
                        {
                           "lat": 41.538517,
                           "lon": -90.82444
                        },
                        {
                           "lat": 41.538383,
                           "lon": -90.81443
                        }
                     ],
                     "type": "exterior",
                     "passable": true
                  }
               ]
            }
         ],
         "extent": {
            "topLeft": {
               "lat": 41.538517,
               "lon": -90.82465
            },
            "bottomRight": {
               "lat": 41.530777,
               "lon": -90.81443
            }
         },
         "links": [
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/boundaries/6232611a-0303-0234-8g7d-e1e1e11871b8"
            },
            {
               "rel": "fields",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/boundaries/6232611a-0303-0234-8g7d-e1e1e11871b8/fields"
            },
            {
               "rel": "owningOrganization",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234"
            }
         ],
         "id": "6232611a-0303-0234-8g7d-e1e1e11871b8",
         "active": "true"
      }
   ]
}
 
[1] Types of Boundaries:  
exterior Outer border of the field.
interior Blocked area inside the field.
GET /organizations/{orgID} /boundaries /{id}
View a Boundary
View a single boundary. The response will include links to the following resources:
  • fields: View the field associated with these boundaries.
  • owningOrganizations: View the organization that owns the field.
 
Request URI
GET: https://apicert.soa-proxy.deere.com/platform/organizations/{orgID}/boundaries/{id}
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Request Header
Header Key Type Example Description Default Required?
Accept-UOM-System string METRIC Takes METRIC and ENGLISH. Converts measurements to the chosen system. METRIC No.
 
Request Parameter
This endpoint does not currently support any filters/request parameters.
 
Response Details
Field Type Example Description
id string 6232611a-0303-0234-8g7d-e1e1e11871b8 Boundary ID
name string 4/4/2014 1:35:30 PM Boundary name
Area --- See sample response below. Boundary area
multipolygons --- See sample response below. Boundary shape and exact location.
type string exterior Boundary type1
passable boolean true "True" indicates that the boundary can be crossed (Ex: a waterway). "False" indicates that the boundary cannot be crossed (ex: a boulder).
extent --- See sample response below. Coordinates of the extent of the boundary.
active boolean true Indicates whether or not the boundary is active.
 
Sample Response [JSON]
200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
   "name": "2/25/2015 6:01:19 PM",
   "area": {
      "valueAsDouble": 70.8407,
      "unit": "ha"
   },
   "multipolygons": [
      {
         "rings": [
            {
               "points": [
                  {
                     "lat": 41.538383,
                     "lon": -90.81443
                  },
                  {
                     "lat": 41.530777,
                     "lon": -90.81459
                  },
                  {
                     "lat": 41.530895,
                     "lon": -90.82465
                  },
                  {
                     "lat": 41.538517,
                     "lon": -90.82444
                  },
                  {
                     "lat": 41.538383,
                     "lon": -90.81443
                  }
               ],
               "type": "exterior",
               "passable": true
            }
         ]
      }
   ],
   "extent": {
      "topLeft": {
         "lat": 41.538517,
         "lon": -90.82465
      },
      "bottomRight": {
         "lat": 41.530777,
         "lon": -90.81443
      }
   },
   "links": [
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/boundaries/6232611a-0303-0234-8g7d-e1e1e11871b8"
      },
      {
         "rel": "fields",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/boundaries/6232611a-0303-0234-8g7d-e1e1e11871b8/fields"
      },
      {
         "rel": "owningOrganization",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234"
      }
   ],
   "id": "6232611a-0303-0234-8g7d-e1e1e11871b8",
   "active": "true"
}
 
[1] Types of Boundaries:  
exterior Outer border of the field.
interior Blocked area inside the field.
GET /organizations/{orgID} /fields/{fieldId} /boundaries
View the Boundaries of a Field
View the boundaries of a specified field. For each data point, the response will link to the following resources:
  • fields: View the field associated with these boundaries.
  • owningOrganizations: View the organization that owns the field.
 
Request URI
GET: https://apicert.soa-proxy.deere.com/platform/organizations/{orgID}/fields/{fieldId}/boundaries
Accept: application/vnd.deere.axiom.v3+xml or application/vnd.deere.axiom.v3+json
 
Request Header
Header Key Type Example Description Default Required?
Accept-UOM-System string METRIC Takes METRIC and ENGLISH. Converts measurements to the chosen system. METRIC No.
 
Request Parameter
This endpoint does not currently support any filters/request parameters.
 
Response Details
Field Type Example Description
id string 6232611a-0303-0234-8g7d-e1e1e11871b8 Boundary ID
name string 4/4/2014 1:35:30 PM Boundary name.
area --- See sample response below. Boundary area.
multipolygons --- See sample response below. Boundary shape and exact location.
type string exterior Boundary type. 1
passable boolean true "True" indicates that the boundary can be crossed (Ex: a waterway). "False" indicates that the boundary cannot be crossed (ex: a boulder).
extent --- See sample response below. Coordinates of the extent of the boundary.
active boolean true Indicates whether or not the boundary is active.
 
Sample Response in JSON
200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
   "links": [
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/fields/6232611a-0303-0234-8g7d-e1e1e11871b8/boundaries"
      }
   ],
   "total": 1,
   "values": [
      {
         "name": "2/25/2015 6:01:19 PM",
         "area": {
            "valueAsDouble": 70.8407,
            "unit": "ha"
         },
         "multipolygons": [
            {
               "rings": [
                  {
                     "points": [
                        {
                           "lat": 41.538383,
                           "lon": -90.81443
                        },
                        {
                           "lat": 41.530777,
                           "lon": -90.81459
                        },
                        {
                           "lat": 41.530895,
                           "lon": -90.82465
                        },
                        {
                           "lat": 41.538517,
                           "lon": -90.82444
                        },
                        {
                           "lat": 41.538383,
                           "lon": -90.81443
                        }
                     ],
                     "type": "exterior",
                     "passable": true
                  }
               ]
            }
         ],
         "extent": {
            "topLeft": {
               "lat": 41.538517,
               "lon": -90.82465
            },
            "bottomRight": {
               "lat": 41.530777,
               "lon": -90.81443
            }
         },
         "links": [
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/boundaries/6232611a-0303-0234-8g7d-e1e1e11871b8"
            },
            {
               "rel": "fields",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/boundaries/6232611a-0303-0234-8g7d-e1e1e11871b8/fields"
            },
            {
               "rel": "owningOrganization",
               "uri": "https://api.deere.com/platform/organizations/1234"
            }
         ],
         "id": "6232611a-0303-0234-8g7d-e1e1e11871b8",
         "active": "true"
      }
   ]
}
 
[1] Types of Boundaries:  
exterior Outer border of the field.
interior Blocked area inside the field.
POST /organizations/{orgID} /fields/{fieldId} /boundaries
Create a Boundary
Create a boundary with a GeoJSON geometry collection for a field.
 
Request URI
POST: https://apicert.soa-proxy.deere.com/platform/organizations/{orgID}/fields/{fieldId}/boundaries
Accept: application/vnd.deere.axiom.v3+json
 
Request Parameters
Header Key Type Example Description Default Required?
orgId long 1234 Organization ID N/A Yes.
fieldId string 98762 Field GUID N/A Yes.
 
Request Details
Field Type Example Description
name string Boundary A Boundary Name
active boolean true Indicates whether the boundary is active in this field.
irrigated boolean true Indicates whether the boundary is irrigated.
geometryCollection --- See sample request below. GeoJSON representation of the new boundary. 1
 
Sample Request JSON
Content-Type: application/vnd.deere.axiom.v3.geo+json

{
   "name": "unique name",
   "active": true,
   "irrigated": false,
   "geometryCollection": {
      "type": "GeometryCollection",
      "geometries": [
         {
            "type": "Polygon",
            "coordinates": [[[-93.67759, 41.60742], [-93.67664,41.60742], [-93.67664, 41.60418], [-93.67759, 41.60418], [-93.67759, 41.60742]]]          }
      ]
   }
}
 
Sample Response
201 Created
 
[1] GeoJSON Note: The first and last coordinates of a GeoJSON collection must be the same to be valid.