GET
/clients
List Clients
GET
/organizations/{orgID}/clients
List Clients in an Org
GET
/organizations/{orgID}/clients/{id}
View a Client
GET
/organizations/{orgID}/fields/{id}/clients
View Clients that Own a Field
GET
/organizations/{orgID}/farms/{id}/clients
View Clients that Own a Farm
Become a beta tester for FieldDetails resources.
The term "client" refers to the grower and/or Operations Center user associated with a specific farm.
GET /clients
List Clients
View all clients within all fields. For each client, the response will link to the following resources:
  • fields: View the field the client belongs to.
  • farms: View the farm belonging to the client.
  • owningOrganization: View the org that owns the client.
 
Request URI
GET: https://apicert.soa-proxy.deere.com/platform/clients
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Request Parameters
This resource does not currently take any filters/request parameters.
 
Response Details
Field Type Example Description
id string MjEwMV81MGJlM2ViMy Client ID
name string Captain Nemo Client Name
 
Sample Response [JSON]
200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
   "links": [
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/clients"
      }
   ],
   "total": 2,
   "values": [
      {
         "name": "Captain Nemo",
         "links": [
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/6789/clients/MjEwMV81MGJlM2ViMy"
            },
            {
               "rel": "fields",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/6789/clients/MjEwMV81MGJlM2ViMy/fields"
            },
            {
               "rel": "farms",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/6789/clients/MjEwMV81MGJlM2ViMy/farms"
            },
            {
               "rel": "owningOrganization",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/6789"
            }
         ],
         "id": "MjEwMV81MGJlM2ViMy"
      },
      {
         "name": "Aslan",
         "links": [
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/6789/clients/MjU0OF81MjZhYTYwZC0"
            },
            {
               "rel": "fields",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/6789/clients/MjU0OF81MjZhYTYwZC0/fields"
            },
            {
               "rel": "farms",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/6789/clients/MjU0OF81MjZhYTYwZC0/farms"
            },
            {
               "rel": "owningOrganization",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/6789"
            }
         ],
         "id": "MjU0OF81MjZhYTYwZC0"
      }
   ]
}
GET /organizations /{orgID} /clients
List Clients in an Org
View a list of clients in a specified organization. For each client, the response will include links to the following resources:
  • fields: View the fields associated with the client.
  • farms: View the farms associated with the client.
  • owningOrganization: View details about the client's organization.
 
Request URI
GET: https://apicert.soa-proxy.deere.com/platform/organizations/{orgID}/clients
Accept: application/vnd.deere.axiom.v3+xml or application/vnd.deere.axiom.v3+json
 
Request Parameters
This resource does not currently take any filters/request parameters.
 
Response Details
Field Type Example Description
id string 6789 Organization ID
name string Captain Nemo Client Name
 
Sample Response [JSON]
200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
   "links": [
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/6789/clients"
      }
   ],
   "total": 2,
   "values": [
      {
         "name": "Captain Nemo",
         "links": [
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/6789/clients/MjEwMV81MGJlM2ViMy"
            },
            {
               "rel": "fields",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/6789/clients/MjEwMV81MGJlM2ViMy/fields"
            },
            {
               "rel": "farms",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/6789/clients/MjEwMV81MGJlM2ViMy/farms"
            },
            {
               "rel": "owningOrganization",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/6789"
            }
         ],
         "id": "MjEwMV81MGJlM2ViMy"
      },
      {
         "name": "Aslan",
         "links": [
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/6789/clients/MjU0OF81MjZhYTYwZC0"
            },
            {
               "rel": "fields",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/6789/clients/MjU0OF81MjZhYTYwZC0/fields"
            },
            {
               "rel": "farms",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/6789/clients/MjU0OF81MjZhYTYwZC0/farms"
            },
            {
               "rel": "owningOrganization",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/6789"
            }
         ],
         "id": "MjU0OF81MjZhYTYwZC0"
      }
   ]
}
GET /organizations/{orgID} /clients {id}
View a Client
View a client's details. For each client, the response will link to the following resources:
  • fields: View the field the client belongs to.
  • farms: View the farm belonging to the client.
  • owningOrganization: View the org that owns the client.
 
Request URI
GET: https://apicert.soa-proxy.deere.com/platform/organizations/{orgID}/clients/{id}
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Request Parameters
This resource does not currently take any filters/request parameters.
 
Response Details
Field Type Example Description
id string MjU0OF81MjZhYTYwZC0 Client ID
name string Aslan Client Name
 
Sample Response [JSON]
200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
   "name": "Aslan",
   "links": [
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/6789/clients/MjU0OF81MjZhYTYwZC0"
      },
      {
         "rel": "fields",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/6789/clients/MjU0OF81MjZhYTYwZC0/fields"
      },
      {
         "rel": "farms",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/6789/clients/MjU0OF81MjZhYTYwZC0/farms"
      },
      {
         "rel": "owningOrganization",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/6789"
      }
   ],
   "id": "MjU0OF81MjZhYTYwZC0"
}
GET /organizations/{orgID} /fields/{id} /clients
View Clients that Own a Field
View details about the client that owns the field. The response will link to the following resources:
  • fields: View the field the client belongs to.
  • farms: View the farms belonging to the client.
  • owningOrganization: View the org that owns the field.
 
Request URI
GET: https://apicert.soa-proxy.deere.com/platform/fields/{id}/clients
Accept: application/vnd.deere.axiom.v3+xml or application/vnd.deere.axiom.v3+json
 
Request Parameters
This resource does not currently take any filters/request parameters.
 
Response Details
Field Type Example Description
id string MjU0OF81MjZhYTYwZC0A Client ID
name string Aslan Client Name
 
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/6789/fields/MWUxZTExODZiMzg/clients"
      }
   ],
   "total": 1,
   "values": [
      {
         "name": "Aslan",
         "links": [
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/6789/clients/MjU0OF81MjZhYTYwZC0"
            },
            {
               "rel": "fields",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/6789/clients/MjU0OF81MjZhYTYwZC0/fields"
            },
            {
               "rel": "farms",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/6789/clients/MjU0OF81MjZhYTYwZC0/farms"
            },
            {
               "rel": "owningOrganization",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/6789"
            }
         ],
         "id": "MjU0OF81MjZhYTYwZC0A"
      }
   ]
}
GET /organizations/{orgID} /farms/{id} /clients
View Clients that Own a Farm
View details about the client that owns the farm. The response will link to the following resources:
  • fields: View the field that the client belongs to.
  • farms: View the farms belonging to this client.
  • owningOrganization: View the org that owns the client.
 
Request URI
GET: https://apicert.soa-proxy.deere.com/platform/organizations/{orgID}/farms/{id}/clients
Accept: application/vnd.deere.axiom.v3+xml or application/vnd.deere.axiom.v3+json
 
Request Parameters
This resource does not currently take any filters/request parameters.
 
Response Details
Field Type Example Description
id string MjU0OF81MjZhYTYwZC0 Client ID
name string Captain Nemo Client Name
 
Sample Response [JSON]
200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
   "links": [
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/farms/MTY4MDY3XzQ0MzB/clients"
      }
   ],
   "total": 1,
   "values": [
      {
         "name": "Pierre Arronax",
         "links": [
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/clients/MjU0OF81MjZhYTYwZC0"
            },
            {
               "rel": "fields",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/clients/MjU0OF81MjZhYTYwZC0/fields"
            },
            {
               "rel": "farms",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/clients/MjU0OF81MjZhYTYwZC0/farms"
            },
            {
               "rel": "owningOrganization",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234"
            }
         ],
         "id": "MjU0OF81MjZhYTYwZC0"
      }
   ]
}