GET
/partnerships
List Partners
POST
/partnerships
Set Up a Partnership
GET
/partnerships/{tokenId}
Get Partnership Details
DELETE
/partnerships/{tokenId}
Delete a Partnership
GET
/partnerships/{tokenId}/permissions
View Permissions in a Partnership
POST
/partnerships/{tokenId}/permissions
Request/Assign Permissions
GET
/partnerships/{tokenId}/permissions/{type}
View a Permission Type
DELETE
/partnerships/{tokenId}/files /{fileId}
Revoke Sharing on a File
GET
/partnerships/{tokenId}/files
View Details of Shared Files
POST
/partnerships/{tokenId}/files
Add a File to a Partnership
GET
/files/{fileId}/partnerships
View Partners Who Share A File
Partnerships on Operations Center represent business relationships between organizations. Two partnered organizations can share files either individually or automatically with each other. Organizations can also specify the type of relationship they have with a partner and enable automatic file sharing for that purpose. For example, a grower Organization can automatically share all their agronomic data with an agronomist’s organization.
GET /partnerships  
List Partners
This request allows the client to view a list of partners. Each data point links to the following:
  • fromPartnership: View the organization that initiated the partnership.
  • toPartnership: View the organization that the partner request was sent to. If the partnership has not been accepted, only the org's email address will be returned.
    To return a pending partnership's token, request partnership details one at a time with the invitationToken stored in the invitation object. In the response, the <toPartnership> element will replace the <uri> with <OrgID>. The partner's org ID will be returned when the partnership status is <ACCEPTED>. While the partnership status is <PENDING>, the partner's org name and ID will not be returned.
  • permissions: View the permissions assigned within the partnership.
  • files: View the files shared within the partnership.
  • contactInvitation: The tokenID specific to the partnership.
 
Request URI
GET https://apicert.soa-proxy.deere.com/platform/partnerships
Accept application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Request Parameters
This resource does not currently support any parameters.
 
Response Details
Field Type Example Description
status string REJECTED View the status of the partnership.1
 
Sample Response [JSON]
200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
   "links": [
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/partnerships"
      },
      {
         "rel": "nextPage",
         "uri": "https://apicert.soa-proxy.deere.com/platform/partnerships;start=10;count=10"
      }
   ],
   "total": 2,
   "values": [
      {
         "links": [
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/partnerships/2b1b34fc-2cc3-4a57-8120-28ea912113fc"
            },
            {
               "rel": "fromPartnership",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/0987"
            },
            {
               "rel": "toPartnership",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234"
            },
            {
               "rel": "permissions",
               "uri": "https://apicert.soa-proxy.deere.com/platform/partnerships/2b1b34fc-2cc3-4a57-8120-28ea912113fc/permissions"
            },
            {
               "rel": "files",
               "uri": "https://apicert.soa-proxy.deere.com/platform/partnerships/2b1b34fc-2cc3-4a57-8120-28ea912113fc/files"
            },
            {
               "rel": "contactInvitation",
               "uri": "https://apicert.soa-proxy.deere.com/platform/partnerships/c3cf441b-d814-400b-842c-44fb7ecad703"
            }
         ],
         "status": "ACCEPTED"
      },
      {
         "links": [
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/partnerships/4ecbb066-bd4c-485e-bcf8-99a470364d5a"
            },
            {
               "rel": "fromPartnership",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/7654"
            },
            {
               "rel": "toPartnership",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234"
            },
            {
               "rel": "permissions",
               "uri": "https://apicert.soa-proxy.deere.com/platform/partnerships/4ecbb066-bd4c-485e-bcf8-99a470364d5a/permissions"
            },
            {
               "rel": "files",
               "uri": "https://apicert.soa-proxy.deere.com/platform/partnerships/4ecbb066-bd4c-485e-bcf8-99a470364d5a/files"
            },
            {
               "rel": "contactInvitation",
               "uri": "https://apicert.soa-proxy.deere.com/platform/partnerships/47f27b3a-2639-4bc4-a1c3-33dc0bce32ac"
            }
         ],
         "status": "ACCEPTED"
      }
   ]
}
 
[1] Status Values: Pending; Accepted; Revoked; Rejected; Change Request
 
POST /partnerships  
Set Up a Partnership
This request will set up a partnership between two organizations.
 
Request URI
POST https://apicert.soa-proxy.deere.com/platform/partnerships
Accept application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Sample Request [JSON]
{
   "links": [
      {
         "rel": "toPartnership",
         "uri": "mailto:partnerorg@gmail.com"
      },
      {
         "rel": "fromPartnership",
         "uri": "https://api.soa-proxy.deere.com/platform/organizations/140881"
      }
   ]
}
Sample Response [JSON]
Response:
201 Created

Date: Mon, 17 Mar 2014 15:56:13 GMT
Server: Apache-Coyote/1.1
X-Deere-Handling-Server: ldxtc2
X-Deere-Elapsed-Ms: 2300
Content-Type: text/plain
Location: https://apicert.soa-proxy.deere.com/platform/partnerships/6076f729-d3b0-4297-bfb4-8f88b99420ac
Connection: Keep-Alive
Keep-Alive: timeout=5, max=99
Content-Length: 0
 
GET /partnerships /{tokenId}
Get Partnership Details
This request allows the client to view partnership details. The response links to the following resources:
  • fromPartnership: View the organization that initiated the partnership.
  • toPartnership: View the organization that the partner request was sent to. If the partnership has not been accepted, only the org's email address will be returned.
    To return a pending partnership's token, request partnership details one at a time with the invitationToken stored in the invitation object. In the response, the <toPartnership> element will replace the <uri> with <OrgID>. The partner's org ID will be returned when the partnership status is <ACCEPTED>. While the partnership status is <PENDING>, the partner's org name and ID will not be returned.
  • permissions: View the permissions assigned within the partnership.
  • files: View the files shared within the partnership.
  • contactInvitation: The tokenID specific to the partnership.
 
Request URI
GET https://apicert.soa-proxy.deere.com/platform/partnerships/{tokenId}
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Request Parameters
This endpoint does not currently support any request parameters/filters.
 
Response Details
Field Type Example Description
status string PENDING View the status of the partnership.1
 
Sample Response [JSON]
200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
   "links": [
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/partnerships/2b1b34fc-2cc3-4a57-8120-28ea912113fc"
      },
      {
         "rel": "fromPartnership",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/0987"
      },
      {
         "rel": "toPartnership",
         "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234"
      },
      {
         "rel": "permissions",
         "uri": "https://apicert.soa-proxy.deere.com/platform/partnerships/2b1b34fc-2cc3-4a57-8120-28ea912113fc/permissions"
      },
      {
         "rel": "files",
         "uri": "https://apicert.soa-proxy.deere.com/platform/partnerships/2b1b34fc-2cc3-4a57-8120-28ea912113fc/files"
      },
      {
         "rel": "contactInvitation",
         "uri": "https://apicert.soa-proxy.deere.com/platform/partnerships/c3cf441b-d814-400b-842c-44fb7ecad703"
      }
   ],
   "status": "ACCEPTED"
}
 
[1] Status Values: Pending; Accepted; Revoked; Rejected; Change Request
DELETE /partnerships /{tokenId}
Delete a Partnership
This request lets the client delete a partnership.
 
Request URI
DELETE https://apicert.soa-proxy.deere.com/platform/partnerships/{tokenId}
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Sample Response
Response:

204 No Content

Date: Mon, 17 Mar 2014 16:01:32 GMT
Server: Apache-Coyote/1.1
X-Deere-Handling-Server: ldxtc4
X-Deere-Elapsed-Ms: 856
Content-Type: text/plain
Connection: Keep-Alive
Keep-Alive: timeout=5, max=100
Content-Length: 0
GET /partnerships /{tokenId} /permissions
View Permissions in a Partnership
This request allows the client to view all the permissions that one partner has assigned the other. The response will also link to the Assign Permissions resource, which will allow the client to assign permissions to a partner.
 
Request URI
GET https://apicert.soa-proxy.deere.com/platform/partnerships/{tokenId}/permissions
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Request Parameters
This endpoint does not currently support any request parameters/filters.
 
Response Details
Field Type Example Description
type string prescription Files The type of permission.1
status string notGiven Indicates whether this permission has been granted to the partner org. Possible values are: Not Given, Requested, and Approved.
 
Sample Response [JSON]
200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
   "links": [
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/partnerships/2b1b34fc-2cc3-4a57-8120-28ea912113fc/permissions"
      },
      {
         "rel": "requestPermissions",
         "uri": "https://apicert.soa-proxy.deere.com/platform/partnerships/2b1b34fc-2cc3-4a57-8120-28ea912113fc/permissions"
      }
   ],
   "permissions": [
      {
         "links": [
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/partnerships/2b1b34fc-2cc3-4a57-8120-28ea912113fc/permissions/productionAgronomicDetailData"
            }
         ],
         "type": "productionAgronomicDetailData",
         "status": "requested"
      },
      {
         "links": [
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/partnerships/2b1b34fc-2cc3-4a57-8120-28ea912113fc/permissions/prescriptionFiles"
            }
         ],
         "type": "prescriptionFiles",
         "status": "notGiven"
      }
   ]
}
 
[1] Permission Statuses: Machine Performance Data; Machine Terminal Retrieval Capabilities; Machine Management; Production Agronomic Detail Data; Prescription Files; Setup Files; Send Files to Machine Capabilities; All Machines; Location History; Remote Display Access; All Fields; Manual Shared Fields; Administrator Level Access to Customer Organization Account; Share On Behalf Of
 
POST  /partnerships /{tokenId} /permissions
Request/Assign Permissions
This request allows the client to update a partner permission or request a permission from a partner. To enable file sharing within this partnership, assign or request the relevant permission type.1
 
Request URI
POST https://apicert.soa-proxy.deere.com/platform/partnerships/{tokenId}/permissions/{permissionType}
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Sample Response [JSON]
Accept: application/vnd.deere.axiom.v3+json
Authorization: OAuth realm="",oauth_timestamp="1395085116",oauth_nonce="tJfBil", oauth_consumer_key="com.deere.portal", oauth_token="9bad5c26-8eef-49be-bae1-860edb224c59", oauth_version="1.0",oauth_signature_method="HMAC-SHA1", oauth_signature="uAjmD1uM4NBWGQg8v9tgBwxat1M%3D"
Content-Type: application/vnd.deere.axiom.v3+json

{
   "permissions": [
      {
         "type": "productionAgronomicDetailData",
         "status": "requested"
      }
   ]
}
 
[1] Permission Types: MACHINE_PERFORMANCE_DATA; MACHINE_TERMINAL_RETRIEVAL_CAPABILITIES; MACHINE_MANAGEMENT; PRODUCTION_AGRONOMIC_DETAIL_DATA; PRESCRIPTION_FILES; SETUP_FILES; SEND_FILES_TO_MACHINE_CAPABILITIES; ALL_MACHINES; LOCATION_HISTORY; REMOTE_DISPLAY_ACCESS; ALL_FIELDS; MANUAL_SHARED_FIELDS; ADMINISTRATOR_LEVEL_ACCESS_TO_CUSTOMER_ORGANIZATION_ACCOUNT; SHARE_ON_BEHALF_OF
GET /partnerships /{tokenId} /permissions/{type}
View a Permission Type
This request allows the client to view a specific permission type with a partner.
 
Request URI
GET https://apicert.soa-proxy.deere.com/platform/partnerships/{tokenID}/permissions/{type}
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Response Details
Field Type Example Description
type string setupFiles The type of permission.1
status string requested Indicates whether this permission has been granted to the partner org. Possible values are: Not Given, Requested, and Approved.
 
Sample Response [JSON]
200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
   "permissionId": "204",
   "type": "setupFiles",
   "status": "requested",
   "links": [
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/partnerships/3c83hd-3kd3-1k64-8235-28dnn2d82h/permissions/setupFiles"
      }
   ]
}
 
[1] Permission Types: MACHINE_PERFORMANCE_DATA; MACHINE_TERMINAL_RETRIEVAL_CAPABILITIES; MACHINE_MANAGEMENT; PRODUCTION_AGRONOMIC_DETAIL_DATA; PRESCRIPTION_FILES; SETUP_FILES; SEND_FILES_TO_MACHINE_CAPABILITIES; ALL_MACHINES; LOCATION_HISTORY; REMOTE_DISPLAY_ACCESS; ALL_FIELDS; MANUAL_SHARED_FIELDS; ADMINISTRATOR_LEVEL_ACCESS_TO_CUSTOMER_ORGANIZATION_ACCOUNT; SHARE_ON_BEHALF_OF
DELETE /partnerships /{tokenId} /files/{fileId}
Revoke Sharing on a File
This request allows the client to stop sharing a file with a partner.
 
Request URI
DELETE https://apicert.soa-proxy.deere.com/platform/partnerships/{tokenID}/files/{fileID}
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Sample Response
204 No Content

Date: Tue, 18 Mar 2014 16:51:27 GMT
Server: Apache-Coyote/1.1
X-Deere-Handling-Server: ldxtc1
X-Deere-Elapsed-Ms: 2810
Content-Type: text/plain
Connection: Keep-Alive
Keep-Alive: timeout=5, max=100
Content-Length: 0
GET /partnerships /{tokenId} /files
View Details of Shared Files
This request allows the client to view specific details about a file shared between partner organizations. For each requested file, the response will also link to the following resources:
  • owningOrganization: View the details of the organization who owns the file.
  • partnerships: View the partnerships through which the file is shared.
  • initiateFileTransfer: Submit a request to transfer the file to a specified machine.
  • machinesEligibleToReceiveFile: View a list of WDT-capable machines that can receive the file.
  • revokeFileShare: Request to stop sharing the file with this partner.
 
Request URI
GET https://apicert.soa-proxy.deere.com/platform/partnerships/{tokenId}/files
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Request Parameters
This endpoint does not currently support any request parameters/filters.
 
Response Details
Field Type Example Description
id string 0987654 File ID.
name string SmithFarmPrescription.zip File name.
type string PRESCRIPTION File type.
createdTime dateTime 2015-02- 03T10:42: 24.282Z Time that the file was created.
modifiedTime dateTime 2015-02- 03T10:42: 24.282Z Time that the file was last modified.
nativeSize integer 72946 Size of the file in bytes.
source string JohnDoe The account that created the file.
transferPending boolean false Indicates whether the file is currently being transferred to a machine.
visibleViaShare string owned Indicates whether you own the file, or it was shared with you.
shared boolean true Indicates whether the file is shared with a partner org.
new boolean false Indicates whether the file is new.
status string TRANSFERABLE Indicates whether the file can be transfered to a machine.
archived boolean false Indicates whether the file has been archived.
 
Sample Response [JSON]
200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
   "links": [
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/partnerships/2b1b34fc-2cc3-4a57-8120-28ea912113fc/files"
      }
   ],
   "total": 1,
   "values": [
      {
         "links": [
            {
               "rel": "owningOrganization",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/0987"
            },
            {
               "rel": "sharedToOrganization",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234"
            },
            {
               "rel": "partnerships",
               "uri": "https://apicert.soa-proxy.deere.com/platform/files/0987654/partnerships"
            },
            {
               "rel": "initiateFileTransfer",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/fileTransfers"
            },
            {
               "rel": "machinesEligibleToReceiveFile",
               "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": "wdtCapableMachines",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234/machines?capability=wdt"
            },
            {
               "rel": "revokeFileShare",
               "uri": "https://apicert.soa-proxy.deere.com/platform/partnerships/2b1b34fc-2cc3-4a57-8120-28ea912113fc/files/0987654"
            },
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/files/0987654"
            }
         ],
         "id": "0987654",
         "name": "SmithFarmsPrescription.zip",
         "type": "PRESCRIPTION",
         "createdTime": "2015-02-03T10:42:24.282Z",
         "modifiedTime": "2015-02-03T10:42:24.282Z",
         "nativeSize": 72946,
         "source": "JohnDoe",
         "transferPending": false,
         "visibleViaShare": "manual",
         "shared": false,
         "status": "READY",
         "archived": false,
         "new": false
      }
   ]
}
POST /partnerships /{tokenId} /files
Add a File to a Partnership
This request will add a file to a partnership. This file will then be available to both organizations within the partnership.
 
Request URI
POST https://apicert.soa-proxy.deere.com/platform/partnerships/{tokenId}/files
Accept application/vnd.deere.axiom.v3+xml or application/vnd.deere.axiom.v3+json
 
Request Details
Field Type Example Description
@type string File Object type.
name string JohnSmith_rx_jan21.zip File name.
type string PRESCRIPTION File type. 1
createdTime dateTime 2014-01-21T22:28:55.485Z Time at which this file was created.
modifiedTime dateTime 2015-10-22T01:40:46.083Z Time at which this file was last modified.
nativeSize integer 2015-10-22T01:40:46.083Z Time at which this file was last modified.
source string JOHNSMITH User that created this file.
transferPending boolean false Indicates whether this file is pending to be transfered to a machine.
visibleViaShare string owned Indicates whether this file is visible to this user because it was shared through a partnership. "Owned" indicates that the user owns this file.
shared boolean true Indicates whether this file is shared through a partnership.
new boolean false Indicates whether this file is new.
status string READY Indicates the file status. 2
archived boolean true Indicates whether the file has been archived.
manufacturer string John Deere Machine manufacturer
id string 12345 File ID
 
Sample Request [JSON]
{
   "values": [
      {
         "@type": "File",
         "name": "JohnSmith_rx_jan21.zip",
         "type": "PRESCRIPTION",
         "createdTime": "2014-01-21T22:28:55.485Z",
         "modifiedTime": "2015-10-22T01:40:46.083Z",
         "nativeSize": 132295,
         "source": "JOHNSMITH",
         "transferPending": false,
         "visibleViaShare": "owned",
         "shared": true,
         "new": false,
         "status": "READY",
         "archived": true,
         "manufacturer": "John Deere",
         "id": "12345",
         "links": [
            {
               "@type": "Link",
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/files/12345"
            }
         ]
      }
   ]
}
 
Sample Response
204 No Content
 
[1] File Types:
Number Type Description
0 SETUP Collection of attributes sent to a precision agricultural display to help ensure accurate execution and documentation of work. Examples of the attributes include: client, farm, field, boundary, guidance lines, products, machines, implements, operators, and equipment offsets.
1 PRESCRIPTION A file developed for a precision agricultural display and implement controller to command the rate of product applied for a specific zone inside a predefined boundary.
2 INVALID The uploaded file has an unsupported format. The file cannot be processed, downloaded, or sent to a machine.
3 UNKNOWN This file has not yet been fully uploaded or is still being processed. Once processed, the type should be automatically updated.
4 DOC Operational data captured from a precision agricultural display. The approved data operations are: Seeding, Harvest, Application, Tillage & Other.
6 HIC Eleven geospatially traceable attributes documenting the quality of each cotton module harvested by a John Deere 7760 Cotton Picker with the added Application Controller.
7 TIMBERLINK N/A
8 EXPORT Removal of processed and edited field data from Operations Center in a shapefile format.
11 TIMBERMATIC N/A
13 PDF A normal PDF file.
 
[2] File Statuses: UPLOAD_PENDING; READY; IN_PROGRESS
GET /files /{filesId} /partnerships
View Partners Who Share A File
This request allows the client to view the partners with whom a file is shared.
 
Request URI
GET https://apicert.soa-proxy.deere.com/platform/files/{fileId}/partnerships
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Request Parameters
This endpoint does not currently support any request parameters/filters.
 
Sample Response [JSON]
200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
   "links": [
      {
         "rel": "self",
         "uri": "http://api.deere.com/platform/files/0987654/partnerships"
      }
   ],
   "total": 1,
   "values": [
      {
         "links": [
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/partnerships/2b1b34fc-2cc3-4a57-8120-28ea912113fc"
            },
            {
               "rel": "fromPartnership",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/0987"
            },
            {
               "rel": "toPartnership",
               "uri": "https://apicert.soa-proxy.deere.com/platform/organizations/1234"
            },
            {
               "rel": "permissions",
               "uri": "https://apicert.soa-proxy.deere.com/platform/partnerships/2b1b34fc-2cc3-4a57-8120-28ea912113fc/permissions"
            },
            {
               "rel": "files",
               "uri": "https://apicert.soa-proxy.deere.com/platform/partnerships/2b1b34fc-2cc3-4a57-8120-28ea912113fc/files"
            },
            {
               "rel": "contactInvitation",
               "uri": "https://apicert.soa-proxy.deere.com/platform/partnerships/c3cf441b-d814-400b-842c-44fb7ecad703"
            }
         ],
         "status": "CHANGE_REQUEST"
      }
   ]
}