GET
/source/{sourceId}/client
List Clients
GET
/source/{sourceId}/client/{clientId}
View a Client
POST
/source/{sourceId}/client/{clientId}
Create/Update Client
POST
/source/{sourceId}/client/{clientId}
Delete Client
Client Definition
GET /source /{sourceId} /client
List Clients
 
Request URI
GET: https://api.soa-proxy.deere.com/aglogic/source/{sourceId}/client/
Accept: */*
 
Request Parameters
This resource does not currently take any filters/request parameters.
 
Response Details
Field Type Example Description
client --- See sample response below. Client information.
id integer 3 Client ID.
name string Marie Curie Client Name
 
Sample Response in XML
<?xml version="1.0" encoding="UTF-8"?>
<clients xmlns="http://www.w3.org/2005/Atom" xml:lang="en">
  <link>
    <rel>Clients</rel>
    <uri>"https://apicert.soa-proxy.deere.com/aglogic/source/x/client"</uri>
  </link>
  <client>
    <id>3</id>
    <name>Marie Curie</name>
    <link>
      <rel>Client</rel>
      <uri>https://apicert.soa-proxy.deere.com/aglogic/source/x/client/3</uri>
    </link>
  </client>
  <client>
    <id>0000000002</id>
    <name>Artful Dodger</name>
    <link>
      <rel>Client</rel>
      <uri>https://apicert.soa-proxy.deere.com/aglogic/source/x/client/0000000002</uri>
    </link>
  </client>
  <client>
    <id>0000000008</id>
    <name>Oliver TWist</name>
    <link>
      <rel>Client</rel>
      <uri>https://apicert.soa-proxy.deere.com/aglogic/source/x/client/0000000008</uri>
    </link>
  </client>
</clients>
 
GET /source/{sourceId} /client/{clientId}
View a Client
 
Request URI
GET: https://api.soa-proxy.deere.com/aglogic/source/{sourceId}/client/{clientId}
Accept: */*
 
Request Parameters
This resource does not currently take any filters/request parameters.
 
Response Details
Field Type Example Description
acres num 3.0 Acres of property.
street1 string 3 Main St. Street address line 1.
street1 string Apt 100 Street address line 2.
city string Maycomb City.
state string AL State.
zip string 30012 Zip code.
email string atticus.finch@finchlaw.com Email address.
phone string 123.456.7890 Phone number.
entry-point --- See sample request below. Includes the coordinates of the entry point of this client's farm.
boundary --- See sample request below. Boundary of this client's farm.
farms --- See sample request below. Farms belonging to this client. Includes name and ID.
fields --- See sample request below. Fields belonging to this client. Includes name and ID.
 
Sample Response in XML
<?xml version="1.0" encoding="UTF-8"?>
<client xmlns="http://www.w3.org/2005/Atom" xml:lang="en">
  <id>0000103010</id>
  <name>Atticus Finch</name>
  <link>
    <rel>client</rel>
    <uri>"https://apicert.soa-proxy.deere.com/aglogic/source/x/client/0000103010"</uri>
  </link>
  <acres>3.0</acres>
  <street1>3 Main Street</street1>
  <street2 />
  <city>Maycomb</city>
  <state>AL</state>
  <zip>30022</zip>
  <email>atticus.finch@finchlaw.com</email>
  <phone>123.456.7890</phone>
  <entryPoint>
    <coordinates />
  </entryPoint>
  <farms>
    <link>
      <rel>Farms</rel>
      <uri>https://apicert.soa-proxy.deere.com/aglogic/source/x/client/0000103010/farm</uri>
    </link>
    <farm>
      <id>1</id>
      <name>Church RD Farms</name>
      <link>
        <rel>self</rel>
        <uri>https://apicert.soa-proxy.deere.com/aglogic/source/x/client/0000103010//farm/1</uri>
      </link>
      <fields>
        <link>
          <rel>Fields</rel>
          <uri>https://apicert.soa-proxy.deere.com/aglogic/source/x/client/0000103010/farm/1/field</uri>
        </link>
        <field>
          <id>1</id>
          <name>Church RD</name>
          <link>
            <rel>self</rel>
            <uri>https://apicert.soa-proxy.deere.com/aglogic/source/x/client/0000103010/farm/1/field/1</uri>
          </link>
        </field>
      </fields>
    </farm>
  </farms>
  <boundary />
</client>
 
POST /source/{sourceId} /client/{clientId}
Create/Update Client
 
Request URI
POST: https://api.soa-proxy.deere.com/aglogic/source/{sourceId}/client/{clientId}/
Accept: */*
 
Request Parameters
This resource does not currently take any filters/request parameters.
 
Request Details
Field Type Example Description
name string Atticus Finch Client Name
acres integer 3 Number of acres owned by this client.
street1 string 3 Main Street Street address
city string Maycomb City name.
state string AL State name.
zip string 30022 Zip code.
email string atticus.finch@finchlaw.com Email address.
phone string 123.456.7890 Phone number.
entry-point --- See sample request below. Includes the coordinates of the entry point of this client's field.
boundary --- See sample request below. Boundary of this client's field.
 
Sample Request in XML
https://api.soa-proxy.deere.com/aglogic/source/223031/client/1/

<?xml version="1.0" encoding="UTF-8"?>
<client xmlns="http://www.deere.com/agriservices/schemas/nutrientlogistics/ backofficeintegration"
xmlns:kml="http://earth.google.com/kml/2.1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <name>Atticus Finch</name>
  <acres>3</acres>
  <street1>3 Main Street</street1>
  <city>Maycomb</city>
  <state>AL</state>
  <zip>30022</zip>
  <email>atticus.finch@finchlaw.com</email>
  <phone>123.456.7890</phone>
  <entry-point>
    <kml:coordinates>-84.1, 33.1</kml:coordinates>
  </entry-point>
  <boundary />
</client>
 
Response Codes
Codes  
200 Success.
400 Bad Request. Check that the passed data is in the right format and passes schema validation.
401 Unauthorized. There is a problem with the credentials provided.
404 Problem with the URL. Check that the URL matches the pattern described above.
500 Server error. An unexpected error occurred on the server processing your post.
POST /source/{sourceId} /client/{clientId}
Delete Client
Request URI
POST: https://api.soa-proxy.deere.com/aglogic/source/{sourceId}/client/{clientId}?_method=delete
Accept: */*
Note:You would expect that we would use HTTP DELETE here. However, many web hosting environments, including John Deere’s, do not allow HTTP DELETES. Because of this we have to “tunnel” our Delete request using the URL.
 
Request Parameters
This resource does not currently take any filters/request parameters.
 
Request Details
Field Type Example Description
name string Atticus Finch Client Name
acres integer 3 Number of acres owned by this client.
street1 string 3 Main Street Street address
city string Maycomb City name.
state string AL State name.
zip string 30022 Zip code.
email string atticus.finch@finchlaw.com Email address.
phone string 123.456.7890 Phone number.
entry-point --- See sample request below. Includes the coordinates of the entry point of this client's field.
boundary --- See sample request below. Boundary of this client's field.
 
Sample Request in XML
https://api.soa-proxy.deere.com/aglogic/source/223031/client/1/

<?xml version="1.0" encoding="UTF-8"?>
<client xmlns="http://www.deere.com/agriservices/schemas/nutrientlogistics/ backofficeintegration"
xmlns:kml="http://earth.google.com/kml/2.1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <name>Atticus Finch</name>
  <acres>3</acres>
  <street1>3 Main Street</street1>
  <city>Maycomb</city>
  <state>AL</state>
  <zip>30022</zip>
  <email>atticus.finch@finchlaw.com</email>
  <phone>123.456.7890</phone>
  <entry-point>
    <kml:coordinates>-84.1, 33.1</kml:coordinates>
  </entry-point>
  <boundary />
</client>
 
Response Codes
Codes  
200 Success.
400 Bad Request. It is likely that the client specified cannot be deleted. The client may have assigned or open orders associated with it.
401 Unauthorized. There is a problem with the credentials provided.
404 Problem with the URL. Check that the URL matches the pattern described above.
500 Server error. An unexpected error occurred on the server processing your post.
Client Definitions  
Client
client is the business entity associated with the farms and fields.
 
   
id BMS unique identifier for the client. This identifier must be unique within an organization in AgLogic™.
name Client's name.
acres Number of acres covered by this client.
street1 Address field one of this client.
street2 Address field two of this client.
city The city where this client is located.
state State where this client is located.
zip Zip code of the client.
email Email address of this client's contact.
phone Phone number of this client's contact.
entry point(s) Lat/Lon pair(s) identifying the client entry point.
field boundary Collection of data describing the boundaries of the client.