API docs by Redocly

Perfect Flight - API Reference (1.0.0)

Download OpenAPI specification:

Perfect Flight: developer@perfectflightapp.com URL: https://www.perfectflight.com.br/#contato License: Proprietary — Perfect Flight

Response compression

Responses are compressed automatically (gzip or Brotli) whenever the client sends the Accept-Encoding header — virtually every HTTP client does this by default, so no extra configuration is usually needed on your side. This matters most on large list endpoints (e.g. GET /fields, GET /farms, GET /applications), which can return heavy geometry data in boundaries; see the withBoundaries query parameter on those endpoints for a way to reduce the payload further by leaving that field out.

farm

Farms and their hierarchy

create a new farm

create a new farm

Authorizations:
auth
header Parameters
x-pf-correlation-id
string <uuid> (CorrelationHeader)
Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1

correlation identifier between request and response

Request Body schema: application/json
required
name
required
string

farm name

namespace
required
string

group to which the farm belongs

parentFarmId
string <uuid>

identification of the parent farm.

enter this attribute when you want to associate a farm with an existing one (as if it were a tree structure).

Responses

Request samples

Content type
application/json
{
  • "name": "My Farm",
  • "namespace": "Farms",
  • "parentFarmId": "bfc780ae-3873-4caf-92d3-9b7ae4ea2a57"
}

Response samples

Content type
application/json
{
  • "id": "20f94ebe-361b-44e6-9729-57d744d04b27",
  • "name": "My Farm",
  • "namespace": "Farms",
  • "createdAt": "2024-05-27T22:52:44.903Z"
}

search all farms

search all farms

Authorizations:
auth
query Parameters
withDeleted
boolean (WithDeletedQueryParameter)
Default: false
Example: withDeleted=true

include deleted farms

namespace
string or null
Example: namespace=Farms

farm namespace

name
string or null
Example: name=My Farm

farm name

parentFarmId
string or null <uuid>
Example: parentFarmId=09650ecf-a354-4d6b-9092-6c0f8d037a92

parent farm id

page
integer <int32> (PageQueryParameter)
Default: 1
Example: page=2

current page number

pageSize
integer <int32> (PageSizeQueryParameter)
Default: 10
Example: pageSize=20

number of farms per page

withBoundaries
boolean (WithBoundariesQueryParameter)
Default: true
Example: withBoundaries=false

when false, skips aggregating the boundaries field of each farm (returned as an empty geometry), reducing query size for large lists

header Parameters
x-pf-correlation-id
string <uuid> (CorrelationHeader)
Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1

correlation identifier between request and response

Responses

Response samples

Content type
application/json
[
  • {
    }
]

search farm by id

search farm by id

Authorizations:
auth
path Parameters
farmId
required
string <uuid>
Example: c17ebf24-e2bd-4c83-88fc-f2c8b0e43883

unique farm identification

header Parameters
x-pf-correlation-id
string <uuid> (CorrelationHeader)
Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1

correlation identifier between request and response

Responses

Response samples

Content type
application/json
{
  • "id": "20f94ebe-361b-44e6-9729-57d744d04b27",
  • "name": "My Farm",
  • "namespace": "Farms",
  • "area": 155.43,
  • "count": 29,
  • "boundaries": "MULTIPOLYGON (((-63.7279364 -8.8349494,-63.7264692 -8.8379071,-63.7252954 -8.8373272,-63.7272909 -8.8346015,-63.7279364 -8.8349494)),((-63.7265866 -8.8333836,-63.7268213 -8.8324557,-63.7245324 -8.8322238,-63.7246498 -8.8331516,-63.7265866 -8.8333836)))",
  • "hasChildren": true,
  • "childrenAmount": 2,
  • "parentFarmId": "a4f8d25b-27cd-473a-ae25-ed6e8ff8f321",
  • "parentFarm": {
    },
  • "farmNameHierarchy": [
    ],
  • "createdAt": "2024-05-27T22:52:44.903Z",
  • "updatedAt": "2024-05-27T22:55:44.903Z",
  • "deletedAt": "2024-05-27T22:59:44.903Z"
}

search all fields by farm id

search all fields by farm id

Authorizations:
auth
path Parameters
farmId
required
string <uuid>

unique farm identification

query Parameters
withDeleted
boolean (WithDeletedQueryParameter)
Default: false
Example: withDeleted=true

include deleted fields

page
integer <int32> (PageQueryParameter)
Default: 1
Example: page=2

current page number

pageSize
integer <int32> (PageSizeQueryParameter)
Default: 10
Example: pageSize=20

number of fields per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

field

Fields belonging to farms

search all fields

search all fields

Authorizations:
auth
query Parameters
withDeleted
boolean (WithDeletedQueryParameter)
Default: false
Example: withDeleted=true

include deleted fields

page
integer <int32> (PageQueryParameter)
Default: 1
Example: page=2

current page number

pageSize
integer <int32> (PageSizeQueryParameter)
Default: 10
Example: pageSize=20

number of fields per page

withBoundaries
boolean (WithBoundariesQueryParameter)
Default: true
Example: withBoundaries=false

when false, omits the boundaries field of each field, reducing query and response size for large lists

header Parameters
x-pf-correlation-id
string <uuid> (CorrelationHeader)
Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1

correlation identifier between request and response

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create a new field

create a new field

Authorizations:
auth
header Parameters
x-pf-correlation-id
string <uuid> (CorrelationHeader)
Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1

correlation identifier between request and response

Request Body schema: application/json
required
name
required
string

field name

boundaries
required
string <wkt>

object in wkt format that represents the georeferencing of the field

farmId
required
string <uuid>

unique farm identification to which the field will be associated

Responses

Request samples

Content type
application/json
{
  • "name": "Field 01",
  • "boundaries": "POLYGON ((-56.1736668 -15.5591935,-56.1731188 -15.5592036,-56.1731971 -15.5595204,-56.1737295 -15.5594852,-56.1736668 -15.5591935))",
  • "farmId": "20f94ebe-361b-44e6-9729-57d744d04b27"
}

Response samples

Content type
application/json
{
  • "id": "b48207a5-9408-4b92-b15f-6954b225c0b6",
  • "name": "Field 01",
  • "area": 33.43,
  • "farm": {
    },
  • "boundaries": "POLYGON ((-56.1736668 -15.5591935,-56.1731188 -15.5592036,-56.1731971 -15.5595204,-56.1737295 -15.5594852,-56.1736668 -15.5591935))",
  • "createdAt": "2024-05-27T22:52:44.903Z",
  • "updatedAt": "2024-05-27T22:55:44.903Z"
}

search field by id

search field by id

Authorizations:
auth
path Parameters
fieldId
required
string <uuid>
Example: ecafbb6f-c7b4-43d6-bf54-5f7dd98d8377

unique field identification

query Parameters
withDeleted
boolean (WithDeletedQueryParameter)
Default: false
Example: withDeleted=true

include deleted fields

header Parameters
x-pf-correlation-id
string <uuid> (CorrelationHeader)
Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1

correlation identifier between request and response

Responses

Response samples

Content type
application/json
{
  • "id": "b48207a5-9408-4b92-b15f-6954b225c0b6",
  • "name": "Field 01",
  • "area": 33.43,
  • "boundaries": "POLYGON ((-56.1736668 -15.5591935,-56.1731188 -15.5592036,-56.1731971 -15.5595204,-56.1737295 -15.5594852,-56.1736668 -15.5591935))",
  • "farm": {
    },
  • "createdAt": "2024-05-27T22:52:44.903Z",
  • "updatedAt": "2024-05-27T22:55:44.903Z",
  • "deletedAt": "2024-05-27T22:59:44.903Z"
}

application

Product application records and their results

search all applications

search all applications

Authorizations:
auth
query Parameters
withDeleted
boolean (WithDeletedQueryParameter)
Default: false
Example: withDeleted=true

include deleted applications

serviceOrderId
string <uuid>
Example: serviceOrderId=46e842b6-f4e8-4503-9c3e-bfdc34604849

unique service order identification

seasonId
string <uuid>
Example: seasonId=21c85837-cf04-49a6-9a9e-2661060ef502

unique season identification

page
integer <int32> (PageQueryParameter)
Default: 1
Example: page=2

current page number

pageSize
integer <int32> (PageSizeQueryParameter)
Default: 10
Example: pageSize=20

number of applications per page

order
string (SortOrderEnum)
Default: "asc"
Enum: "asc" "desc"
Example: order=asc

sort direction for the results, always ordered by createdAt

withBoundaries
boolean (WithBoundariesQueryParameter)
Default: true
Example: withBoundaries=false

when false, omits the boundaries field of each application field, reducing response size for large lists

crop
string (CropEnum)
Enum: "unknown" "cotton" "corn" "avocado" "bean" "brachiaria" "cereals" "citrus" "cocoa" "coconut" "coffee" "eucalyptus" "grape" "oat" "orange" "peanut" "pineapple" "potato" "rice" "soybean" "sugarcane" "sunflower" "wheat" "sunn_hemp" "pearl_millet" "sorghum" "stylosanthes" "cover" "millet" "banana" "tobacco" "sesame" "seed_corn"
Example: crop=cotton

season crop

pilotId
string <uuid> (PilotId)
Example: pilotId=d902bd61-6b7f-451e-970c-4576d1fbb238

unique pilot identification

aerialCompanyId
string <uuid>
Example: aerialCompanyId=075773c3-0f4b-4ac0-b74b-6e777ec0a4bd

unique aerial company identification

farmId
string <uuid>
Example: farmId=075773c3-0f4b-4ac0-b74b-6e777ec0a4bd

unique farm identification

applicationDateType
string (ApplicationDateTypeEnum)
Enum: "application_date" "analysis_date"
Example: applicationDateType=application_date

application date type

applicationType
string (ApplicationTypeEnum)
Enum: "aerial" "terrestrial"
Example: applicationType=aerial

application type

startedIn
string <date-time>
Example: startedIn=2024-06-01T22:52:44.903Z

application start date

finishedIn
string <date-time>
Example: finishedIn=2024-06-30T22:52:44.903Z

application end date

object
Example: filter[status]=[object Object]&filter[createdAt]=[object Object]

Bracket-style filters in the form filter[<field>][<operator>]=<value>, e.g. filter[status][eq]=complete. Combines (AND) with the other query parameters. Multiple fields and operators can be sent in the same request.

field type allowed operators
status ApplicationStatusEnum eq, ne, in
applicationType ApplicationTypeEnum eq, ne, in
processedAt date-time eq, gt, gte, lt, lte
createdAt date-time gte, lte
season.crop CropEnum eq, in

For in, send comma-separated values (e.g. filter[status][in]=active,in_analysis). Unknown fields, unknown or disallowed operators and invalid values return 400.

Example: GET /applications?filter[status][in]=active,in_analysis&filter[createdAt][gte]=2024-06-01T00:00:00.000Z&filter[season.crop][eq]=cotton

header Parameters
x-pf-correlation-id
string <uuid> (CorrelationHeader)
Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1

correlation identifier between request and response

Responses

Response samples

Content type
application/json
{
  • "applications": [
    ],
  • "total": 42
}

search application by id

search application by id

Authorizations:
auth
path Parameters
applicationId
required
string <uuid>
Example: fa2a8bbd-5f1d-4012-a022-12a28f676057

unique application identification

header Parameters
x-pf-correlation-id
string <uuid> (CorrelationHeader)
Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1

correlation identifier between request and response

Responses

Response samples

Content type
application/json
{
  • "id": "fa2a8bbd-5f1d-4012-a022-12a28f676057",
  • "season": {
    },
  • "status": "complete",
  • "analysisMethod": "COMPLETE_TARGET",
  • "applicationType": "aerial",
  • "deletedReason": "wrong_application_data",
  • "notChargeable": false,
  • "inspectionFlags": [
    ],
  • "inspectionStatus": "not_inspected",
  • "inspectionReason": "unknown",
  • "inspectionObservation": "my application inspection comments",
  • "deletedObservation": "duplicated application, recreated as OS-1234568",
  • "fields": [
    ],
  • "farms": [
    ],
  • "restrictionFields": [
    ],
  • "schedules": [
    ],
  • "logs": [
    ],
  • "products": [
    ],
  • "applicationOperationalServices": [
    ],
  • "applicationTrack": {
    },
  • "runway": {
    },
  • "operationalReportId": "8f0a5e2c-1b3d-4f6a-9c8e-7d6b5a4f3e2d",
  • "processedAt": "2024-05-27T22:52:44.903Z",
  • "lastReprocessedAt": "2024-05-27T22:52:44.903Z",
  • "serviceOrder": {
    },
  • "averageSuccessScore": 98.45,
  • "averageFailureScore": 98.45,
  • "averageUniformityScore": 98.45,
  • "averageWasteScore": 98.45,
  • "averageRateFlow": 98.45,
  • "plannedAverageRateFlow": 98.45,
  • "flowRateDataByGroup": [
    ],
  • "layers": [
    ],
  • "images": [
    ],
  • "averageSpeed": 98.45,
  • "averageHeight": 98.45,
  • "plannedAverageHeight": 98.45,
  • "heightDataByGroup": [
    ],
  • "speedDataByGroup": [
    ],
  • "plannedAverageSpeed": 98.45,
  • "flowRangeVariation": 98.45,
  • "heightRangeVariation": 98.45,
  • "totalInternalAppliedOverlapArea": 98.45,
  • "totalExternalAppliedOverlapArea": 98.45,
  • "totalInternalAppliedArea": 98.45,
  • "totalExternalAppliedArea": 98.45,
  • "totalAppliedOverlapArea": 98.45,
  • "totalTargetFieldArea": 98.45,
  • "totalNotAppliedArea": 98.45,
  • "totalDistanceTraveled": 98.45,
  • "totalAppliedArea": 98.45,
  • "totalCroppedNotAppliedArea": 98.45,
  • "totalAppliedOverdoseArea": 98.45,
  • "totalCostByArea": 98.45,
  • "totalCostByAppliedArea": 98.45,
  • "totalCostByTargetFieldArea": 98.45,
  • "totalCostByExternalAppliedArea": 98.45,
  • "totalCostByInternalAppliedArea": 98.45,
  • "totalCostByInternalAppliedOverlapArea": 98.45,
  • "totalCostByExternalAppliedOverlapArea": 98.45,
  • "displacementMargin": 147.67,
  • "averageSampleRate": 2.58,
  • "createdAt": "2024-05-27T22:52:44.903Z",
  • "updatedAt": "2024-05-27T22:55:44.903Z",
  • "deletedAt": "2024-05-27T22:59:44.903Z"
}

product

Products available for application

create a new product

create a new product

Authorizations:
auth
header Parameters
x-pf-correlation-id
string <uuid> (CorrelationHeader)
Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1

correlation identifier between request and response

Request Body schema: application/json
required
alias
required
string

product alias

manufacturerName
string or null
Default: "Unknown"

name of the manufacturer of the product

productId
required
string <uuid>

unique identifier of the suggested product this new product registration is associated with. Every customer product must be linked to one from the catalog — there is no support for a standalone product not tied to a suggested product.

code
integer or null

custom product code

measurementUnit
required
string (MeasurementUnitEnum)
Enum: "l" "ha" "ac" "m" "kg" "km" "°" "°c" "°f" "mm" "%"

measurement unit

object (AmountDto)

Responses

Request samples

Content type
application/json
{
  • "alias": "My Product Example",
  • "manufacturerName": "Manufacturer Example",
  • "productId": "efae9cea-767f-4d28-a4e6-891ee7b0e998",
  • "code": 946749,
  • "measurementUnit": "l",
  • "amount": {
    }
}

Response samples

Content type
application/json
{
  • "id": "efae9cea-767f-4d28-a4e6-891ee7b0e998",
  • "customer": {
    },
  • "currency": "BRL",
  • "cost": 332.43,
  • "code": 946749,
  • "alias": "My Product Example",
  • "manufacturerName": "Manufacturer Example",
  • "classType": "fungicide",
  • "serviceType": "pesticide_application",
  • "formulation": "wettable_powder",
  • "toxicityCategory": "category_3_moderately_toxic",
  • "colorBand": "blue",
  • "measurementUnit": "l",
  • "createdAt": "2024-05-27T22:52:44.903Z",
  • "updatedAt": "2024-05-27T22:55:44.903Z"
}

search all products

search all products

Authorizations:
auth
query Parameters
withDeleted
boolean (WithDeletedQueryParameter)
Default: false
Example: withDeleted=true

include deleted products

manufacturerName
string
Example: manufacturerName=Manufacturer Example

product manufacturer name

alias
string
Example: alias=My Custom Product

product alias

code
integer or null
Example: code=2932493

custom product code

classType
string (ProductClassTypeEnum)
Default: "unknown"
Enum: "unknown" "ripener" "adjuvant" "insecticide" "acaricide" "fungicide" "nematicide" "herbicide" "bactericide" "biological" "adulticide" "foliar_nutrition" "larvicide" "fertilizer" "phytohormone" "ant_killer" "seeding" "microbiological" "plant_activator" "termiticide" "pheromone" "plant_growth_regulator" "molluscicide" "seed_protectant" "biological_control_agent" "acaricide_bactericide_fungicide" "acaricide_ant_killer_insecticide" "acaricide_fungicide" "acaricide_fungicide_insecticide" "acaricide_insecticide" "acaricide_insecticide_nematicide" "acaricide_microbiological" "acaricide_microbiological_insecticide_microbiological" "bactericide_fungicide" "bactericide_microbiological_fungicide_microbiological" "termiticide_ant_killer_insecticide" "termiticide_insecticide" "pheromone_insecticide" "ant_killer_fungicide_herbicide_insecticide_nematicide" "ant_killer_fungicide_herbicide_nematicide" "ant_killer_insecticide" "fungicide_nematicide" "fungicide_nematicide_microbiological" "fungicide_herbicide_nematicide" "fungicide_insecticide" "fungicide_insecticide_nematicide" "fungicide_microbiological" "fungicide_microbiological_nematicide_microbiological" "herbicide_plant_growth_regulator" "insecticide_plant_growth_regulator" "fumigant_insecticide" "insecticide_microbiological" "insecticide_nematicide" "nematicide_microbiological"
Example: classType=fungicide

product class type

page
integer <int32> (PageQueryParameter)
Default: 1
Example: page=2

current page number

pageSize
integer <int32> (PageSizeQueryParameter)
Default: 10
Example: pageSize=20

number of products per page

header Parameters
x-pf-correlation-id
string <uuid> (CorrelationHeader)
Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1

correlation identifier between request and response

Responses

Response samples

Content type
application/json
{
  • "products": [
    ],
  • "total": 2
}

season

Crop seasons

create a new season

create a new season

Authorizations:
auth
header Parameters
x-pf-correlation-id
string <uuid> (CorrelationHeader)
Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1

correlation identifier between request and response

Request Body schema: application/json
required
startedIn
required
string <date-time>

timestamp in RFC 3339 format (UTC) in which the season was started

finishedIn
required
string <date-time>

timestamp in RFC 3339 format (UTC) in which the season was finished

crop
required
string (CropEnum)
Enum: "unknown" "cotton" "corn" "avocado" "bean" "brachiaria" "cereals" "citrus" "cocoa" "coconut" "coffee" "eucalyptus" "grape" "oat" "orange" "peanut" "pineapple" "potato" "rice" "soybean" "sugarcane" "sunflower" "wheat" "sunn_hemp" "pearl_millet" "sorghum" "stylosanthes" "cover" "millet" "banana" "tobacco" "sesame" "seed_corn"

crop type

Responses

Request samples

Content type
application/json
{
  • "startedIn": "2024-05-27T22:52:44.903Z",
  • "finishedIn": "2024-05-27T22:52:44.903Z",
  • "crop": "cotton"
}

Response samples

Content type
application/json
{
  • "id": "fe1e9d3c-18fa-4e31-86c1-38c33be1856c",
  • "customer": {
    },
  • "startedIn": "2024-05-27T22:52:44.903Z",
  • "finishedIn": "2024-05-27T22:52:44.903Z",
  • "crop": "cotton",
  • "createdAt": "2024-05-27T22:52:44.903Z",
  • "updatedAt": "2024-05-27T22:55:44.903Z",
  • "deletedAt": "2024-05-27T22:59:44.903Z"
}

search all seasons

search all seasons

Authorizations:
auth
query Parameters
withDeleted
boolean (WithDeletedQueryParameter)
Default: false
Example: withDeleted=true

include deleted seasons

page
integer <int32> (PageQueryParameter)
Default: 1
Example: page=2

current page number

pageSize
integer <int32> (PageSizeQueryParameter)
Default: 10
Example: pageSize=20

number of seasons per page

header Parameters
x-pf-correlation-id
string <uuid> (CorrelationHeader)
Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1

correlation identifier between request and response

Responses

Response samples

Content type
application/json
{
  • "seasons": [
    ],
  • "total": 2
}

search season by id

search season by id

Authorizations:
auth
path Parameters
seasonId
required
string <uuid>
Example: 3ffa8c69-cc87-46b6-b824-e62feb97f237

unique season identification

header Parameters
x-pf-correlation-id
string <uuid> (CorrelationHeader)
Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1

correlation identifier between request and response

Responses

Response samples

Content type
application/json
{
  • "id": "fe1e9d3c-18fa-4e31-86c1-38c33be1856c",
  • "customer": {
    },
  • "startedIn": "2024-05-27T22:52:44.903Z",
  • "finishedIn": "2024-05-27T22:52:44.903Z",
  • "crop": "cotton",
  • "createdAt": "2024-05-27T22:52:44.903Z",
  • "updatedAt": "2024-05-27T22:55:44.903Z",
  • "deletedAt": "2024-05-27T22:59:44.903Z"
}

vehicle

Vehicles used in applications

search all vehicles

search all vehicles

Authorizations:
auth
query Parameters
name
string

filter by vehicle name

type
string (VehicleTypeEnum)
Enum: "drone" "aircraft" "tractor"
Example: type=drone

filter by vehicle type

serialNumber
string

filter by vehicle serial number

header Parameters
x-pf-correlation-id
string <uuid> (CorrelationHeader)
Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1

correlation identifier between request and response

Responses

Response samples

Content type
application/json
{
  • "vehicles": [
    ],
  • "total": 3
}

pilot

Pilots operating the vehicles

search all pilots

search all pilots

Authorizations:
auth
query Parameters
withDeleted
boolean (WithDeletedQueryParameter)
Default: false
Example: withDeleted=true

include deleted pilots

page
integer <int32> (PageQueryParameter)
Default: 1
Example: page=2

current page number

pageSize
integer <int32> (PageSizeQueryParameter)
Default: 10
Example: pageSize=20

number of pilots per page

header Parameters
x-pf-correlation-id
string <uuid> (CorrelationHeader)
Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1

correlation identifier between request and response

Responses

Response samples

Content type
application/json
{
  • "pilots": [
    ],
  • "total": 2
}

suggested products

Suggested products catalog

search all suggested products

search all suggested products

Authorizations:
auth
query Parameters
name
string or null
Example: name=Suggested Product Example

suggested product name

classType
string (ProductClassTypeEnum)
Default: "unknown"
Enum: "unknown" "ripener" "adjuvant" "insecticide" "acaricide" "fungicide" "nematicide" "herbicide" "bactericide" "biological" "adulticide" "foliar_nutrition" "larvicide" "fertilizer" "phytohormone" "ant_killer" "seeding" "microbiological" "plant_activator" "termiticide" "pheromone" "plant_growth_regulator" "molluscicide" "seed_protectant" "biological_control_agent" "acaricide_bactericide_fungicide" "acaricide_ant_killer_insecticide" "acaricide_fungicide" "acaricide_fungicide_insecticide" "acaricide_insecticide" "acaricide_insecticide_nematicide" "acaricide_microbiological" "acaricide_microbiological_insecticide_microbiological" "bactericide_fungicide" "bactericide_microbiological_fungicide_microbiological" "termiticide_ant_killer_insecticide" "termiticide_insecticide" "pheromone_insecticide" "ant_killer_fungicide_herbicide_insecticide_nematicide" "ant_killer_fungicide_herbicide_nematicide" "ant_killer_insecticide" "fungicide_nematicide" "fungicide_nematicide_microbiological" "fungicide_herbicide_nematicide" "fungicide_insecticide" "fungicide_insecticide_nematicide" "fungicide_microbiological" "fungicide_microbiological_nematicide_microbiological" "herbicide_plant_growth_regulator" "insecticide_plant_growth_regulator" "fumigant_insecticide" "insecticide_microbiological" "insecticide_nematicide" "nematicide_microbiological"
Example: classType=fungicide

suggested product class type

withDeleted
boolean (WithDeletedQueryParameter)
Default: false
Example: withDeleted=true

include deleted suggested products

page
integer <int32> (PageQueryParameter)
Default: 1
Example: page=2

current page number

pageSize
integer <int32> (PageSizeQueryParameter)
Default: 10
Example: pageSize=20

number of suggested products per page

header Parameters
x-pf-correlation-id
string <uuid> (CorrelationHeader)
Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1

correlation identifier between request and response

Responses

Response samples

Content type
application/json
[
  • {
    }
]

pre flight

Pre-flight service orders

create a new pre flight

create a new pre flight

Authorizations:
auth
header Parameters
x-pf-correlation-id
string <uuid> (CorrelationHeader)
Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1

correlation identifier between request and response

Request Body schema: application/json
required
slug
string

service order identification. Optional — if omitted (or blank), a default of the form OS-{timestamp} is generated and used instead. Either way, the resulting slug must be unique per customer; reusing an existing slug fails with an "already exists" error.

to obtain a valid pre-existing slug instead of letting one be generated, read serviceOrder.slug from GET /applications/{applicationId}.

status
string (ServiceOrderStatusEnum)
Enum: "waiting_job" "in_progress" "ready_to_process" "processing" "complete"

service order status

observation
string or null

pre flight observation

preFlightSeasonId
string <uuid>

unique pre flight season identification

preFlightPilot
Array of strings <uuid> (PilotId) >= 0 items unique [ items <uuid > ]

pilots of pre flight

preFlightVehicle
Array of strings <uuid> (VehicleId) >= 0 items unique [ items <uuid > ]

vehicles of pre flight

preFlightTractor
Array of strings <uuid> (TractorId) >= 0 items unique [ items <uuid > ]

tractors of pre flight

Array of objects (CreatePreFlightFieldDto) >= 0 items unique

fields of pre flight

Array of objects (CreatePreFlightProductDto) >= 0 items unique

products of pre flight

Array of objects (CreatePreFlightRestrictionFieldDto) >= 0 items unique

restriction fields of pre flight

Responses

Request samples

Content type
application/json
{
  • "slug": "OS-1234567899",
  • "status": "complete",
  • "observation": "my pre flight comments",
  • "preFlightSeasonId": "134457d7-58d3-4247-9f67-3fa82b3a0535",
  • "preFlightPilot": [
    ],
  • "preFlightVehicle": [
    ],
  • "preFlightTractor": [
    ],
  • "preFlightField": [
    ],
  • "preFlightProduct": [
    ],
  • "preFlightRestrictionField": [
    ]
}

Response samples

Content type
application/json
{
  • "slug": "OS-1234567899"
}