v1
latestOpenAPI 3.0.02026-08-061380344.2 KBCreate a Treatment
Create a treatment record
Parameters
type REQUIRED
The type of treatment performed. These varies by resource type, but custom values can be supplied as well.
For livestock, support options are:
"Alternative Therapy", "Artificial Insemination", "Branding", "Castration", "Dehorning", "Dental Procedure", "Deworming", "Ear Notching", "Euthanasia", "Grooming", "Hoof Trim", "Medication", "Mites", "Parasite Treatment", "Surgical Procedure", "Tagging", "Tattoo", "Vaccination", "Other Procedure"
For plantings and grow locations, supported options are:
"Blight","Fertilize","Fungus","Herbicide","Insect","Mildew","Mites","Mold","Nutrients","Pesticide","Virus","Other"
date OPTIONAL
The date of the treatment, defaults to today
amount OPTIONAL
An optional string representing the amount/quantity used. For example: 50ml
batch OPTIONAL
Batch information for the product used in the treatment (if applicable)
cost OPTIONAL
A positive numeric value (in your account currency) representing the cost of the treatment
description OPTIONAL
Details or summary of the treatment provided
keywords OPTIONAL
A comma-delimited string of keywords, tags or labels used to find similar treatments
mode OPTIONAL
The method of application of the treatment performed. These vary by resource type, but custom values can be supplied as well.
For livestock, support options are:
"Intramuscular (in the muscle)", "Intramammary (in the udder)", "Intrauterine (in the uterus)", "Intravenous (in the vein)", "Oral (in the mouth)", "Subcutaneous (under the skin)", "Topical (on the skin)", "Other"
For plantings and grow locations, supported options are:
"Granules", "Spray", "Other"
product OPTIONAL
The name of the product used (if applicable)
retreat_date OPTIONAL
An optional date for when to retreat or provide a booster if required.
site OPTIONAL
The location that the treatment was applied. These varies by resource type, but custom values can be supplied as well.
For livestock, support options are:
"Rump", "Flank", "Neck"
For plantings and grow locations, supported options are:
"Leaf", "Seed", "Soil"
technician OPTIONAL
Details or name of the technician or company that performed the treatment.
withdrawal_date OPTIONAL
An optional date for when to the crop or livestock will be safe to harvest after the treatment. Typically used for compliance and food safety requirements for meat or milk production after certain medication or treatments.
Path parameters
Headers
Request body
Example request
{
"amount": "2-mL",
"batch": "123",
"cost": 0,
"date": "2022-02-02",
"description": "First dose",
"keywords": "",
"mode": "Intramuscular (in the muscle)",
"product": "BRSV Vaccine",
"retreat_date": "2022-03-02",
"site": "",
"technician": "",
"type": "Vaccination",
"withdrawal_date": null
}Response
Successful response