GET
/organizations
List Orgs
GET
/organizations/{orgID}
View an Organization
GET
/users/{username}/organizations
View User Orgs
All Operations Center users belong to an organization. An organization can consist of one or more users. They can represent growers or their trusted advisors, such as agronomists, dealers, etc. Each organization can house data pertaining to their operations; for example, a grower organization can hold machine and agronomic data for a specific farm.
GET /organizations    
List Orgs
This request will return a list of organizations.
 
For each returned organization, the response will link to
  • machines: List the machines belonging to the specified organization.
  • wdtCapableMachines: List the machines with WDT Capability (machines able to automatically send and receive files) belonging to the org.
  • addresses: Lists the addresses for the org.
 
Request URI
GET: https://apicert.soa-proxy.deere.com/platform/organizations
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Request Parameters
Parameter Type Example Description Default Required?
userName string JohnDoe Returns a list of organizations of which a particular user is a member. N/A No
orgId string 2101 Returns the name of the organization that corresponds with the given organization ID. N/A No
orgName string Smith Farms Returns a list of organizations that contain the given string in their name. N/A No
 
Response Details
Field Type Example Description
id string 1234 The organization ID.
name string Smith Farms The organization name.
type string customer The organization type: customer or dealer.
addresses string 1234 Smith Lane Addresses for the organization.
partnerships string Apple Farms Partnerships for the organization.
member boolean true TRUE means that the user is a member of the org.
 
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"
      },
      {
         "rel": "nextPage",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations;start=10;count=10"
      }
   ],
   "total": 27,
   "values": [       {
         "links": [
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234"
            },
            {
               "rel": "machines",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/machines"
            },
            {
               "rel": "wdtCapableMachines",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/machines?capability=wdt"
            },
            {
               "rel": "addresses",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/addresses"
            }
         ],
         "id": "1234",
         "name": "Smith Farms",
         "type": "customer",
         "addresses": [],
         "partnerships": [],
         "member": true
      }
   ]
}
 
GET /organizations /{orgId}
View an Organization
This request will return information about an organization, such as its name, type, and whether or not you are a member of the organization. It contains links to the following resources:
  • machines: List the machines belonging to the specified organization.
  • wdtCapableMachines: List the machines with WDT Capability (machines able to automatically send and receive files) belonging to the org.
  • addresses: Lists the addresses for the org.
 
Request URI
GET: https://apicert.soa-proxy.deere.com/platform/organizations/{orgId}
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Request Parameters
This request does not currently support any parameters.
 
Response Details
Field Type Example Description
id string 1234 The organization ID.
name string Smith Farms The organization name.
type string customer The organization type: customer or dealer.
addresses string See sample code below. Addresses for the organization.
partnerships string See sample code below. Partnerships for the organization.
member boolean true TRUE means that the user is a member of the org.
 
Sample Response in JSON
200 OK
Content-Type: application/vnd.deere.axiom.v3+xml

{
   "links": [
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234"
      },
      {
         "rel": "machines",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/machines"
      },
      {
         "rel": "wdtCapableMachines",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/machines?capability=wdt"
      },
      {
         "rel": "addresses",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/addresses"
      }
   ],
   "id": "1234",
   "name": "Smith Farms",
   "type": "customer",
   "addresses": [],
   "partnerships": [],
   "member": true
}
 
GET /users /{username} /organizations
View User Orgs
This endpoint returns a list of all the organizations to which the specified user belongs. For each listed organization, the response contains links to the following resources:
  • machines: List the machines belonging to the specified organization.
  • files: List the files belonging to the specified organization.
  • transferableFiles: List the files in the org that can be transferred to a machine.
  • uploadFile: Resource to upload a file to the specified org.
  • sendFileToMachine: Resource to send a file to a machine in the org.
  • wdtCapableMachines: List WDT-capable machines in the org.
  • addresses: List addresses for the org.
 
Request URI
GET https://apicert.soa-proxy.deere.com/platform/users/{username}/organizations
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Request Parameters
This resource does not currently support any request parameters/filters.
 
Response Details
Field Type Example Description
id string 1234 Organization ID.
name string Smith Farms Organization name.
type string customer Organization type.
addresses string 1234 Smith Lane Addresses associated with the organization.
partnerships string Apple Farms Partners of this organization.
member boolean true Indicates whether the user is a member of the organization.
 
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/users/johndoe/organizations"
      }
   ],
   "total": 2,
   "values": [
      {
         "links": [
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234"
            },
            {
               "rel": "machines",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/machines"
            },
            {
               "rel": "files",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/files"
            },
            {
               "rel": "transferableFiles",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/files?transferable=true"
            },
            {
               "rel": "uploadFile",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/files"
            },
            {
               "rel": "wdtCapableMachines",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/machines?capability=wdt"
            },
            {
               "rel": "sendFileToMachine",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/fileTransfers"
            },
            {
               "rel": "preferences",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/preferences"
            },
            {
               "rel": "addresses",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/addresses"
            }
         ],
         "id": "1234",
         "name": "Smith Farms",
         "type": "customer",
         "addresses": [],
         "partnerships": [],
         "member": true
      },
      {
         "links": [
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/4321"
            },
            {
               "rel": "machines",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/4321/machines"
            },
            {
               "rel": "files",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/4321/files"
            },
            {
               "rel": "transferableFiles",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/4321/files?transferable=true"
            },
            {
               "rel": "uploadFile",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/4321/files"
            },
            {
               "rel": "wdtCapableMachines",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/4321/machines?capability=wdt"
            },
            {
               "rel": "sendFileToMachine",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/4321/fileTransfers"
            },
            {
               "rel": "preferences",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/4321/preferences"
            },
            {
               "rel": "addresses",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/4321/addresses"
            }
         ],
         "id": "4321",
         "name": "Apple Farms",
         "type": "customer",
         "addresses": [],
         "partnerships": [],
         "member": true
      }
   ]
}