POST
/source/{sourceId}/order/{orderId}
Create/Update Work Order
POST
/source/{sourceId}/order/{orderId}
Delete Work Order
Work Order Definitions
POST /source/{sourceId} /order/{orderId}  
Create/Update Work Order
 
Request URI
POST: https://api.soa-proxy.deere.com/aglogic/source/{sourceId}/order/{orderId}
Accept: */*
 
Request Parameters
This resource does not currently take any filters/request parameters.
 
Request Details
Field Type Example Description
field-id string 1 Field ID
farm-id string 1 Farm ID
client-id string 1 Client ID
fields --- See multiple field sample request below. Includes multiple fields associated with an order. Fields can be associated with either one or multiple farms. Include this in the request only if you are requesting multiple fields.
order-number string 005005 Order Number
order-group string 2 Order Group
order-supbgroup string 3 Order Subgroup
order-date string 2015-01-01 Order Date
request-date string 2015-07-02 Request Date
applicator --- See sample request below. Includes the applicator operator and equipment.
crop string Corn Crop Type
analysis string 10-10-10 Order Analysis
total-quantity --- See sample request below. Includes the unit of measurement and the value of the total quantity.
density --- See sample request below. Includes the unit of measurement and the value of the density.
acres string 101 Number of acres in this order.
priority string 1 Priority number among other orders.
variable string 0 ???
application-rate --- See sample request below. Includes the unit of measurement and the value of the application rate.
application-type string DRY Application Type
deliver-method string DELIVER Order delivery method.
comments string Hello Comments in this order.
materials --- See sample request below. Includes the product ID, name, quantity, density, application rate, EPA number, manufacturer, target pest, and adjustability for each material.
tag string This is the tag. Order tag.
county string This is the county. Order county.
 
Sample Request in XML (Single Field Request)
https://api.soa-proxy.deere.com/aglogic/source/223031/order/5

<?xml version="1.0" encoding="UTF-8"?>
<work-order 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">
  <field-id>1</field-id>
  <farm-id>1</farm-id>
  <client-id>1</client-id>
  <order-number>005005</order-number>
  <order-group>2</order-group>
  <order-subgroup>3</order-subgroup>
  <order-date>2015-01-01</order-date>
  <request-date>2015-07-02</request-date>
  <applicator>
    <operator>Jem Finch</operator>
    <equipment>Tender Truck</equipment>
  </applicator>
  <crop>Corn</crop>
  <analysis>10-10-10</analysis>
  <total-quantity uom="TQLbs">1000</total-quantity>
  <density uom="Lbs/Cu. Yard">888</density>
  <acres>101</acres>
  <priority>1</priority>
  <variable-rate>0</variable-rate>
  <application-rate uom="Lbs/Acre">999</application-rate>
  <application-type>DRY</application-type>
  <delivery-method>DELIVER</delivery-method>
  <comments>Comments</comments>
  <materials>
    <material>
      <product-id>abc123</product-id>
      <name>Product 1</name>
      <quantity uom="PrLbs">33</quantity>
      <density uom="Lbs/Cu. Yard">44</density>
      <application-rate uom="Lbs/Acre">55</application-rate>
      <epa-number>XYZ123456789</epa-number>
      <manufacturer>Dow Chemical</manufacturer>
      <target-pest>Herbaceous</target-pest>
      <adjustable>true</adjustable>
    </material>
    <material>
      <product-id>def456</product-id>
      <name>Product 2</name>
      <quantity uom="Lbs">10</quantity>
      <density uom="Lbs/Cu. Yard">20</density>
      <application-rate uom="Lbs/Acre">30</application-rate>
      <adjustable>false</adjustable>
    </material>
  </materials>
  <tag>This is the Tag</tag>
  <county>This is the county</county>
</work-order>
 
Sample Request in XML (Multiple Field Request)
https://api.soa-proxy.deere.com/aglogic/source/223031/order/5

<work-order 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">
  <client-id>1</client-id>
  <fields>
    <field>
      <field-id>1</field-id>
      <farm-id>1</farm-id>
    </field>
    <field>
      <field-id>2</field-id>
      <farm-id>1</farm-id>
    </field>
    <field>
      <field-id>3</field-id>
      <farm-id>2</farm-id>
    </field>
  </fields>
  <order-number>005005</order-number>
  <order-group>2</order-group>
  <order-subgroup>3</order-subgroup>
  <order-date>2015-01-01</order-date>
  <request-date>2015-07-02</request-date>
  <applicator>
    <operator>Jem Finch</operator>
    <equipment>Tender Truck</equipment>
  </applicator>
  <crop>Corn</crop>
  <analysis>10-10-10</analysis>
  <total-quantity uom="TQLbs">1000</total-quantity>
  <density uom="Lbs/Cu. Yard">888</density>
  <acres>101</acres>
  <priority>1</priority>
  <variable-rate>0</variable-rate>
  <application-rate uom="Lbs/Acre">999</application-rate>
  <application-type>DRY</application-type>
  <delivery-method>DELIVER</delivery-method>
  <comments>Comments</comments>
  <materials>
    <material>
      <product-id>abc123</product-id>
      <name>Product 1</name>
      <quantity uom="PrLbs">33</quantity>
      <density uom="Lbs/Cu. Yard">44</density>
      <application-rate uom="Lbs/Acre">55</application-rate>
      <epa-number>XYZ123456789</epa-number>
      <manufacturer>Dow Chemical</manufacturer>
      <target-pest>Herbaceous</target-pest>
      <adjustable>true</adjustable>
    </material>
    <material>
      <product-id>def456</product-id>
      <name>Product 2</name>
      <quantity uom="Lbs">10</quantity>
      <density uom="Lbs/Cu. Yard">20</density>
      <application-rate uom="Lbs/Acre">30</application-rate>
      <adjustable>false</adjustable>
    </material>
  </materials>
  <tag>This is the Tag</tag>
  <county>This is the county</county>
</work-order>
 
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} /order/{orderId}  
Delete Work Order
Request URI
POST: https://api.soa-proxy.deere.com/aglogic/source/{sourceId}/order/{orderId}?_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
field-id string 1 Field ID
farm-id string 1 Farm ID
client-id string 1 Client ID
order-number string 005005 Order Number
order-group string 2 Order Group
order-supbgroup string 3 Order Subgroup
order-date string 2015-01-01 Order Date
request-date string 2015-07-02 Request Date
applicator --- See sample request below. Includes the applicator operator and equipment.
crop string Corn Crop Type
analysis string 10-10-10 Order Analysis
total-quantity --- See sample request below. Includes the unit of measurement and the value of the total quantity.
density --- See sample request below. Includes the unit of measurement and the value of the density.
acres string 101 Number of acres in this order.
priority string 1 Priority number among other orders.
variable string 0 ???
application-rate --- See sample request below. Includes the unit of measurement and the value of the application rate.
application-type string DRY Application Type
deliver-method string DELIVER Order delivery method.
comments string Hello Comments in this order.
materials --- See sample request below. Includes the product ID, name, quantity, density, application rate, EPA number, manufacturer, target pest, and adjustability for each material.
tag string This is the tag. Order tag.
county string This is the county. Order county.
 
Sample Request in XML
https://api.soa-proxy.deere.com/aglogic/source/223031/order/5

https://api.soa-proxy.deere.com/aglogic/source/223031/order/5

<?xml version="1.0" encoding="UTF-8"?>
<work-order 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">
  <field-id>1</field-id>
  <farm-id>1</farm-id>
  <client-id>1</client-id>
  <order-number>005005</order-number>
  <order-group>2</order-group>
  <order-subgroup>3</order-subgroup>
  <order-date>2015-01-01</order-date>
  <request-date>2015-07-02</request-date>
  <applicator>
    <operator>Jem Finch</operator>
    <equipment>Tender Truck</equipment>
  </applicator>
  <crop>Corn</crop>
  <analysis>10-10-10</analysis>
  <total-quantity uom="TQLbs">1000</total-quantity>
  <density uom="Lbs/Cu. Yard">888</density>
  <acres>101</acres>
  <priority>1</priority>
  <variable-rate>0</variable-rate>
  <application-rate uom="Lbs/Acre">999</application-rate>
  <application-type>DRY</application-type>
  <delivery-method>DELIVER</delivery-method>
  <comments>Comments</comments>
  <materials>
    <material>
      <product-id>abc123</product-id>
      <name>Product 1</name>
      <quantity uom="PrLbs">33</quantity>
      <density uom="Lbs/Cu. Yard">44</density>
      <application-rate uom="Lbs/Acre">55</application-rate>
      <epa-number>XYZ123456789</epa-number>
      <manufacturer>Dow Chemical</manufacturer>
      <target-pest>Herbaceous</target-pest>
      <adjustable>true</adjustable>
    </material>
    <material>
      <product-id>def456</product-id>
      <name>Product 2</name>
      <quantity uom="Lbs">10</quantity>
      <density uom="Lbs/Cu. Yard">20</density>
      <application-rate uom="Lbs/Acre">30</application-rate>
      <adjustable>false</adjustable>
    </material>
  </materials>
  <tag>This is the Tag</tag>
  <county>This is the county</county>
</work-order>
 
Response Codes
Codes  
200 Success.
400 Bad Request. It is likely that the order specified cannot be deleted. Only orders that are unassigned are allowed to be deleted.
401 Unauthorized. There is a problem with the credentials provided.
404 Problem with the URL. Check that the URL matches the pattern described above, and that the orderId is known to AgLogic.
500 Server error. An unexpected error occurred on the server processing your post.
Work Order Definitions  
Work Order
work order is a request for delivery of materials or application of materials to a field.
 
   
location id BMS unique identifier of the location where the work order was generated.
field id BMS identifier of the Field where the Work Order is to be applied/delivered. This attribute is considered optional since an order may be associated directly with a farm or a client. However, if the order is associated with a field or farm, then this attribute must be provided.
client id BMS identifier of the client requesting the work order to be applied/delivered.
order id BMS unique identifier of the work order.
order number BMS document number of the work order. This is the work order’s customer facing number.
order group Some business systems allow for a single order to be divided into multiple components, and sub-components. For example, an order may be made for 5 tons of products, but it is delivered in two shipments/applications of 2.5 tons. In this case, two Work Orders would be sent to AgLogic™. Each will have the same order number, but each will have a different order group, and each must have a different order id. AgLogic will treat these orders as separate entities, but will group them together when displaying them, and allow them to be assigned as a group. This is an optional field, but if order sub-group is present, then order group must be present as well.
order sub-group A further sub-division of an order in the BMS (see description of order group above). An order in the BMS can be divided into groups and sub-groups. These orders will be treated as separate entities in AgLogic, and each must have a different order id. They will be grouped together when displaying and will allow for assigning as a sub-group or group. This is an optional field.
order date Date work order was entered into the BMS.
requested date Date that the application/delivery is requested for.
applicator equipment assigned A work order may be imported with the applicator equipment already assigned.
applicator operator assigned A work order may be imported with an applicator operator already assigned.
crop Name of the crop being applied to. This free text field provides information to the applicator operator.
analysis Description of material being applied.
total quantity Total quantity (amount and UOM) of the material being applied.
density Density (amount and UOM) of the material being applied.
legal The legal property description.
county The county that the application occurs.
formula number The formula number of the blend.
land note Notes entered about the land.
weight per area The weight per area of the blend.
volume per area The volume per area of the blend.
total volume The total volume of the blend.
line items The material being applied may be composed of multiple materials that are blended together. The tender driver and the applicator operator may need to know what these components are. Each line item has multiple attributes described below.
product id BMS identifier for the product.
product name Name of the line item material.
product quantity Quantity (amount and UOM) of the line item material.
density Density (amount and UOM) of the line item material.
application rate Application rate (amount and UOM) of the line item material.
epa number  
manufacturer  
target pest  
priority Yes/No indicator as to whether this order is priority.
variable rate Yes/No indicator as to whether this order is variable rate.
acres Number of acres to have material applied.
comments Free form comments to be seen by the scheduler, applicator, and tender driver.
application rate Quantity (amount and UOM) of material to be applied per some unit of area, like 1000 pounds/acre.
application type Dry, Liquid, or Anhydrous.
delivery method Customer pick-up, deliver to customer, or deliver and apply.
tag Custom identifier that will used to group and organize work orders within an organization. This is roughly equivalent to a “Location Code”.