Get Implement
Retrieve agricultural implement information using different methods: by ID, available only, or with search filters.Get by ID
Retrieve detailed information about a specific implement.Endpoint
Path Parameters
The unique identifier of the implement
Response
Indicates if the request was successful
The implement object (see schema below)
Examples
Response Example (200 OK)
Error Responses
Invalid ID (400)
Not Found (404)
Available Implements
Retrieve only implements withstatus: available, sorted by type and power requirement.
Endpoint
Query Parameters
Number of records per page
Number of records to skip
Page number (alternative to offset)
Examples
Response Example (200 OK)
Results are automatically sorted by
implement_type and then by power_requirement_hp.Search Implements
Search implements with advanced filters for type, soil compatibility, and power requirements.Endpoint
Query Parameters
Filter by implement type (exact match, case-insensitive). Valid values:
plowharrowseedersprayerharvestercultivatormowertrailerother
Filter by compatible soil type (partial match, case-insensitive)Example values:
Loam, Clay, Sandy, AllFilter by maximum power requirement in HPReturns only implements requiring ≤ this power
General search across implement name and brand (partial match)
Filter by exact brand name (case-insensitive)
Number of records per page
Number of records to skip
Page number
Examples
Search by Type and Soil
Search by Power Requirement
Find implements that require 60 HP or less:Combined Search
Search for seeders compatible with clay soil requiring max 50 HP:Response Example (200 OK)
The
filters object in the response shows which filters were applied to the search.Implement Types Reference
The following implement types are available in the system:| Type | Description | Typical Use |
|---|---|---|
plow | Disc or moldboard plows | Primary soil tillage, breaking ground |
harrow | Disc or tine harrows | Secondary tillage, soil smoothing |
seeder | Seed planting equipment | Sowing seeds in rows or broadcast |
sprayer | Pesticide/fertilizer sprayers | Applying chemicals or nutrients |
harvester | Harvesting equipment | Crop collection and processing |
cultivator | Soil cultivation tools | Weed control, soil aeration |
mower | Mowing equipment | Cutting grass, hay, or crop residue |
trailer | Agricultural trailers | Transport of crops and materials |
other | Other agricultural implements | Miscellaneous equipment |
Soil Type Compatibility
Common soil type values:- Loam: Balanced mixture of sand, silt, and clay
- Clay: Heavy, moisture-retaining soil
- Sandy: Light, well-draining soil
- Silty: Fine-textured, fertile soil
- All: Compatible with all soil types
Soil type filtering uses partial matching, so searching for “clay” will also match “Heavy clay” or “Clay loam”.
Implementation Notes
Get by ID
- Source:
src/routes/implement.routes.js:273 - Controller:
src/controllers/implementController.js:47-getImplementById - Model:
src/models/Implement.js:12-findById(id) - Public Access: No authentication required
Available Implements
- Source:
src/routes/implement.routes.js:133 - Controller:
src/controllers/implementController.js:139-getAvailableImplements - Model:
src/models/Implement.js:115-getAvailable() - SQL:
SELECT * FROM implement WHERE status = 'available' ORDER BY implement_type, power_requirement_hp
Search Implements
- Source:
src/routes/implement.routes.js:218 - Controller:
src/controllers/implementController.js:72-searchImplements - Filtering: In-memory filtering after fetching all implements
- Case-Insensitive: All text filters are case-insensitive
Related Endpoints
List All Implements
Get a paginated list of all implements
Create Implement
Add a new implement (Admin only)
Update Implement
Modify an existing implement (Admin only)
Delete Implement
Remove an implement (Admin only)
