Skip to main content

Send Prescription (Rx)

Supporting endpoints for Send Prescription (Rx).

Prescription File Upload​

FieldOps supports two methods for uploading prescription (Rx) files:

  1. POST /companies/{companyId}/prescriptionFile - Upload a prescription to a company

  2. POST /companies/{companyId}/vehicles/{VIN}/prescriptionFile - Send a prescription directly to a vehicle

    The request body for both endpoints is submitted as multipart/form-data and contains the prescription file along with the agronomic metadata required to process the prescription.

1. Upload Prescription to a Company​

Uploads a prescription file to the specified company. The prescription becomes available within FieldOps and can subsequently be managed, reviewed, and delivered through FieldOps workflows.

Endpoint

POST /companies/{companyId}/prescriptionFile

URL Parameters

Parameter NameDescription
companyIdUnique identifier of the company.

Request Body

The request must be submitted as multipart/form-data.

{
"file": "ExamplePrescription.zip",
"fieldId": "9441d66c-24f8-43c4-b08f-dc8d76746a0e",
"seasonId": "5f34ff64-5242-4563-b3fc-2c963f66afa7",
"activityTypeId": "3fa85f75-5717-4473-b3fc-2c654f66afa6",
"productId": "7aa85a53-6274-4544-b3fc-2c963f66aff2",
"activityUOMId": "4a34cc64-5727-4562-b3fc-2c963f66aaa5",
"areaUOMId": "55a85f64-5733-4562-b3fc-2c963faa52a6",
"shapeFileAttributeName": "RATE"
}

Prescription File Requirements

The uploaded file must be a ZIP archive containing a valid prescription shapefile dataset. The archive should contain the required shapefile components, including:

  • .shp (Geometry — stores the actual shapes: points, lines, or polygons)
  • .shx (Shape index — helps software quickly locate geometries inside the .shp file)
  • .dbf (Attribute data — a table containing information associated with each shape)
  • .cpg (Character encoding — specifies how text in the .dbf should be interpreted (e.g., UTF-8))
  • .prj (Projection / coordinate system — describes how the geographic coordinates are defined)

The shapeFileAttributeName field specifies the shapefile attribute containing the prescription rate values.

Example:

{
"shapeFileAttributeName": "RATE"
}

The specified attribute must exist within the shapefile attribute table.

Processing When a prescription is uploaded to a company, the prescription is stored within FieldOps and can be managed through standard FieldOps prescription workflows. Additional agronomic associations and validation can be performed within the FieldOps platform.

2. Send Prescription Directly to a Vehicle​

Uploads a prescription file and immediately delivers it to a specific vehicle.

Endpoint

POST /companies/{companyId}/vehicles/{VIN}/prescriptionFile

URL Parameters

Parameter NameDescription
companyIdUnique identifier of the company.
VINVehicle Identification Number of the target vehicle. This value is not a GUID.

Request Body

The request body is identical to the company upload endpoint and must be submitted as multipart/form-data.

{
"file": "123example.cn1.zip",
"fieldId": "9441d66c-24f8-43c4-b08f-dc8d76746a0e",
"seasonId": "5f34ff64-5242-4563-b3fc-2c963f66afa7",
"activityTypeId": "3fa85f75-5717-4473-b3fc-2c654f66afa6",
"productId": "7aa85a53-6274-4544-b3fc-2c963f66aff2",
"activityUOMOId": "4a34cc64-5727-4562-b3fc-2c963f66aaa5",
"areaUOMId": "55a85f64-5733-4562-b3fc-2c963faa52a6",
"shapeFileAttributeName": "EXAMPLE_ATTR"
}

Direct-to-Vehicle Considerations

Sending a prescription directly to a vehicle differs from uploading a prescription through the FieldOps user interface.

When prescriptions are uploaded and processed within FieldOps, users can review and associate the prescription with the appropriate Grower, Farm, Field, Product, and other agronomic information during the processing workflow.

When using the direct-to-vehicle endpoint, this processing workflow is bypassed. Therefore, the prescription file must contain sufficient information to allow FieldOps and the target vehicle to correctly identify and process the prescription.

For best results, prescription files should contain:

  • Grower information
  • Farm information
  • Field information
  • Field boundary information
  • Application rates
  • Application rate units of measure (UOM)

Files that process successfully through the FieldOps application may not produce the same results when sent directly to a vehicle if the required agronomic information is not present in the prescription file itself.

Common Request Fields

Parameter NameDescription
filePrescription ZIP file to upload.
fieldIdField associated with the prescription.
seasonIdSeason associated with the prescription.
activityTypeIdActivity type for the prescription.
productIdProduct associated with the prescription.
activityUOMIdUnit of measure used for the prescription rate.
areaUOMIdArea unit of measure.
shapeFileAttributeNameAttribute in the shapefile containing the prescription rate values.

Best Practices

  • Ensure the uploaded ZIP file contains a valid prescription shapefile dataset.
  • Verify that the value specified in shapeFileAttributeName exists in the shapefile attribute table.
  • Use IDs obtained from the Prescription GET endpoints when constructing the request.
  • Validate prescription files before uploading to production environments.
  • For direct-to-vehicle delivery, ensure the prescription contains sufficient agronomic metadata to support processing without additional user intervention.
  • Confirm that the target vehicle is connected and capable of receiving prescription files before using the vehicle delivery endpoint.

Note

Use /companies/{companyId}/prescriptionFile when the prescription should first be managed within FieldOps. Use /companies/{companyId}/vehicles/{VIN}/prescriptionFile when the prescription should be delivered directly to a specific vehicle.