API docs by Redocly

TrustFlight API (0.2)

Download OpenAPI specification:

The Trustflight API provides direct access to the core data used in Trustflight's applications.

This includes aircraft, sectors, maintenance checks and defects.

Aircraft

The aircraft is the primary entity in the Trustflight ecosystem. Most other entities link directly or indirectly to an aircraft

Lists all aircraft

Returns all aircraft from the system that the user has access to

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

aircraftIds[]
Array of strings <uuid> [ items <uuid > ]
Example: aircraftIds[]=41f10b92-0e8a-4eb4-a17f-c20e7f124999&aircraftIds[]=fdb77302-68a9-4ce1-a2d7-4b42b3b36dcd

An array of Aircraft IDs to limit the returned records by

registration
string
Example: registration=2-TRA

Fuzzy matched (case insensitive) against Aircraft registration

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Fetch the deferred defects list PDF for an aircraft

Returns a binary representation of the aircraft's deferred defects list in PDF format

path Parameters
id
required
string <uuid>

ID of aircraft to use

Responses

Response samples

Content type
application/problem+json
Example
{}

Find aircraft by ID

Returns an aircraft based on ID

path Parameters
id
required
string <uuid>

ID of aircraft to use

Responses

Response samples

Content type
application/json
{
  • "id": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "operatorId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "aircraftTypeId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "serialNumber": "516A0467",
  • "registration": "G-DEMO",
  • "year": 2022,
  • "fuelUnit": "kg",
  • "oilUnit": "ml",
  • "maxFuelValue": 10000,
  • "monthlyCycles": 10,
  • "monthlyFlightSeconds": 54000,
  • "monthlyApuSeconds": 13500,
  • "maintenanceType": "hours",
  • "apuMode": "notInstalled",
  • "flightStatus": "inFlight",
  • "locked": false,
  • "billingStatus": "Active",
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z"
}

Find aircraft by ID and return its serviceability status

Returns the serviceability status for an aircraft

path Parameters
id
required
string <uuid>

ID of aircraft to use

Responses

Response samples

Content type
application/json
{
  • "serviceability": "serviceable"
}

Find aircraft by ID and return its current totals

Returns the current totals for an aircraft

path Parameters
id
required
string <uuid>

ID of aircraft to use

Responses

Response samples

Content type
application/json
{
  • "totals": {
    }
}

Get aircraft totals at a specific datetime

Returns the totals for the specified aircraft at a given datetime. This includes airframe, engine, propeller, and APU statistics.

path Parameters
id
required
string <uuid>

Aircraft ID

query Parameters
datetime
required
string <date-time>
Example: datetime=2024-03-20T12:00:00Z

Datetime for which to retrieve totals

Responses

Response samples

Content type
application/json
{
  • "totals": {
    }
}

Find trips/trip updates by aircraft ID

Returns trips and/or trip updates for a given aircraft ID

path Parameters
id
required
string <uuid>

ID of aircraft to use

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

includeIncomplete
boolean
Default: true
Example: includeIncomplete=false

Whether or not to include incomplete Trips in the response

includeTrips
boolean
Default: true
Example: includeTrips=false

Whether or not to include Trips in the response

includeTripUpdates
boolean
Default: true
Example: includeTripUpdates=false

Whether or not to include TripUpdates in the response

startDate
string <date>
Example: startDate=2022-03-03

The date (inclusive) from which to return the records. Must be <= endDate.

endDate
string <date>
Example: endDate=2022-03-03

The date (inclusive) from which to return the records. Must be >= startDate.

tripIds
Array of strings <uuid> [ items <uuid > ]
Example: tripIds=41f10b92-0e8a-4eb4-a17f-c20e7f124999&tripIds=fdb77302-68a9-4ce1-a2d7-4b42b3b36dcd

An array of Trip IDs to limit the returned Trips by

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Find workpacks by aircraft ID

Returns workpacks for a given aircraft ID

path Parameters
id
required
string <uuid>

ID of aircraft to use

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

startDate
string <date>
Example: startDate=2022-03-03

The date (inclusive) from which to return the records. Must be <= endDate.

endDate
string <date>
Example: endDate=2022-03-03

The date (inclusive) from which to return the records. Must be >= startDate.

status
Array of strings
Default: "pending&status=draft&status=active&status=complete"
Items Enum: "pending" "draft" "active" "complete"
Example: status=active&status=complete

An array of statuses to limit the returned Workpacks by

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Add a Workpack against an Aircraft

Creates a Workpack against the Aircraft with the passed ID

path Parameters
id
required
string <uuid>

The id of the Aircraft to create the Workpack against

Request Body schema: application/json
required
status
string
Enum: "draft" "active" "complete" "pending"
description
string
source
string
Enum: "trustflight" "camp"
notes
string
reference
string
date
string
poNumber
string
mxItemIds
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "status": "draft",
  • "description": "RH/LH Landing Light Replacement",
  • "source": "trustflight",
  • "notes": "some notes against the workpack",
  • "reference": "KCAS-20-002",
  • "date": "2022-02-02T07:08:00Z",
  • "poNumber": "ILBG-20-123",
  • "mxItemIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "c11a0129-6811-4c9f-8004-4bafe2de6999",
  • "aircraftId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "status": "draft",
  • "description": "RH/LH Landing Light Replacement",
  • "source": "trustflight",
  • "notes": "some notes against the workpack",
  • "reference": "KCAS-20-002",
  • "date": "2022-02-02T07:08:00Z",
  • "poNumber": "ILBG-20-123",
  • "mxItemIds": [
    ],
  • "releaseDate": "2022-02-02T07:08:00Z",
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z"
}

Find deice events by aircraft ID

Returns deice events for a given aircraft ID

path Parameters
id
required
string <uuid>
Example: 41f10b92-0e8a-4eb4-a17f-c20e7f124999

ID of aircraft to use

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Returns all Aircraft that belong the the requested Operator

List Aircraft by Operator ID

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

registration
string
Example: registration=2-TRA

Fuzzy matched (case insensitive) against Aircraft registration

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

List Defects for an Aircraft

Returns all Defects that belong to the Aircraft with the passed ID, ordered by dueDate ascending

path Parameters
id
required
string <uuid>

The id of the Aircraft to fetch all Defects for

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

defectTypes[]
Array of any
Default: "CAS&defectTypes[]=CDL&defectTypes[]=MEL&defectTypes[]=NEF&defectTypes[]=Other"
Items Enum: "CAS" "CDL" "MEL" "NEF" "Other"
Example: defectTypes[]=CAS&defectTypes[]=MEL

An array of defect types to filter the returned Defects by.

rectificationCategories[]
Array of any
Default: "A&rectificationCategories[]=ADVISORYONLY&rectificationCategories[]=B&rectificationCategories[]=C&rectificationCategories[]=D&rectificationCategories[]=NONDEFERRED"
Items Enum: "A" "ADVISORYONLY" "B" "C" "D" "NONDEFERRED"
Example: rectificationCategories[]=B&rectificationCategories[]=C

An array of rectification categories to filter the returned Defects by.

statuses[]
Array of any
Items Enum: "open" "resolved" "overdue" "deferral_pending" "resolution_pending"
Example: statuses[]=overdue&statuses[]=resolved

An array of statuses to filter the returned Defects by.

updatedAfter
string <date-time>
Example: updatedAfter=2022-02-14T11:08:00Z

Will only return records that have been updated at or after this datetime

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Returns a paginated list of ScheduledMxItems scoped to the Aircraft with the passed ID

Lists ScheduledMxItems by Aircraft ID

path Parameters
id
required
string <uuid>

ID of the Aircraft that the ScheduledMxItems have been raised against

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

updatedAfter
string <date-time>
Example: updatedAfter=2022-02-14T11:08:00Z

Will only return records that have been updated at or after this datetime

hasAppliedTolerance
boolean
Example: hasAppliedTolerance=true

A boolean to determine whether ScheduledMxItems that have tolerance applied should be returned or not. When omitted all items will be returned regardless of whether they have tolerance applied.

mxArea
Array of strings
Default: "airframe&mxArea=apu&mxArea=engine&mxArea=prop"
Items Enum: "airframe" "apu" "engine" "prop"
Example: mxArea=airframe&mxArea=engine

An array of maintenance areas to filter the returned ScheduledMxItems by.

mxType
Array of strings
Default: "oop&mxType=llp&mxType=scheduled"
Items Enum: "oop" "llp" "scheduled"
Example: mxType=oop&mxType=llp

An array of maintenance types to filter the returned ScheduledMxItems by.

status
Array of strings
Items Enum: "open" "resolved" "overdue" "critical" "draft" "resolution_pending"
Example: status=draft&status=resolved

An array of statuses to filter the returned ScheduledMxItems by

startDueDate
string <date>
Example: startDueDate=2022-03-03

The dueDate (inclusive) from which to return ScheduledMxItems. Must be <= endDueDate.

endDueDate
string <date>
Example: endDueDate=2022-03-03

The dueDate (inclusive) up to which to return ScheduledMxItems. Must be >= startDueDate.

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Create a new ScheduledMxItem

Add a new ScheduledMxItem against an Aircraft

path Parameters
id
required
string <uuid>

ID of aircraft that the ScheduledMxItem should be created against

Request Body schema: application/json
required
aircraftId
string <uuid>
packageId
string <uuid>

The ScheduledMxItem representing the package that this is part of (if any)

draft
boolean
source
string
details
string
name
string
number
integer
dueDate
string <date-time>

Use this in preference to dueDateTime unless you expressly need to specify a time. Only one of dueDate and dueDateTime can be set

dueDateTime
string <date-time>

Only one of dueDate and dueDateTime can be set

estimatedDate
string <date-time>
dueFlightSeconds
integer
dueApuSeconds
integer
dueCycles
integer
dueLandings
integer
repeatFlightSeconds
integer
toleranceFlightSeconds
integer
visibleToleranceFlightSeconds
integer
thresholdFlightSeconds
integer
repeatApuSeconds
integer
toleranceApuSeconds
integer
visibleToleranceApuSeconds
integer
thresholdApuSeconds
integer
repeatDays
integer
toleranceDays
integer
visibleToleranceDays
integer
thresholdDays
integer
repeatMonths
integer
toleranceMonths
integer
visibleToleranceMonths
integer
thresholdMonths
integer
repeatCycles
integer
toleranceCycles
integer
thresholdCycles
integer
repeatRemarks
string
partNumber
string
partSerial
string
reference
string
ataChapter
integer
ataSection
integer
assembly
string
customData
object
operatorReference
string
placardProcedureCompleted
boolean
operationalProcedureCompleted
boolean
crewActionable
boolean
serviceabilityLimiting
boolean
normalisedFlightSecondsDue
integer
normalisedCyclesDue
integer
unitOfTime
string
Enum: "days" "months"
importedAt
string <date-time>
editedBy
string <uuid>
eropsPrevented
boolean
placardNumber
string
calendarDaysAmberLimit
integer

Only one of calendarDaysAmberLimit and calendarDaysSecondsLimit can be set

calendarDaysSecondsLimit
integer

Only one of calendarDaysAmberLimit and calendarDaysSecondsLimit can be set

Responses

Request samples

Content type
application/json
{
  • "aircraftId": "111a0029-6811-4c9f-8e04-4bafe2de6999",
  • "packageId": "f55a0029-6811-4c9f-8e04-4bafe2de6222",
  • "draft": true,
  • "source": "string",
  • "details": "string",
  • "name": "string",
  • "number": 1,
  • "dueDate": "2022-04-04",
  • "dueDateTime": "2022-04-02T17:08:00Z",
  • "estimatedDate": "2022-04-03",
  • "dueFlightSeconds": 1000,
  • "dueApuSeconds": 1000,
  • "dueCycles": 100,
  • "dueLandings": 100,
  • "repeatFlightSeconds": 1000,
  • "toleranceFlightSeconds": 100,
  • "visibleToleranceFlightSeconds": 100,
  • "thresholdFlightSeconds": 10,
  • "repeatApuSeconds": 100,
  • "toleranceApuSeconds": 10,
  • "visibleToleranceApuSeconds": 10,
  • "thresholdApuSeconds": 1,
  • "repeatDays": 50,
  • "toleranceDays": 5,
  • "visibleToleranceDays": 5,
  • "thresholdDays": 2,
  • "repeatMonths": 50,
  • "toleranceMonths": 5,
  • "visibleToleranceMonths": 5,
  • "thresholdMonths": 2,
  • "repeatCycles": 40,
  • "toleranceCycles": 4,
  • "thresholdCycles": 2,
  • "repeatRemarks": "doing it again",
  • "partNumber": "abc-123",
  • "partSerial": "qwerty123",
  • "reference": "tgdbetg",
  • "ataChapter": 59,
  • "ataSection": 5,
  • "assembly": "string",
  • "customData": { },
  • "operatorReference": "456xyz",
  • "placardProcedureCompleted": true,
  • "operationalProcedureCompleted": true,
  • "crewActionable": true,
  • "serviceabilityLimiting": true,
  • "normalisedFlightSecondsDue": 48000,
  • "normalisedCyclesDue": 50,
  • "unitOfTime": "days",
  • "importedAt": "2022-02-02T09:08:00Z",
  • "editedBy": "999e0029-6811-4c9f-8e04-4bafe2de6111",
  • "eropsPrevented": false,
  • "placardNumber": "abc123",
  • "calendarDaysAmberLimit": 10,
  • "calendarDaysSecondsLimit": 129600
}

Response samples

Content type
application/json
{
  • "id": "c11a0029-6811-4c9f-8e04-4bafe2de6999",
  • "aircraftId": "111a0029-6811-4c9f-8e04-4bafe2de6999",
  • "packageId": "f55a0029-6811-4c9f-8e04-4bafe2de6222",
  • "draft": true,
  • "source": "string",
  • "details": "string",
  • "name": "string",
  • "number": 1,
  • "dueDate": "2022-04-04",
  • "dueDateTime": "2022-04-02T17:08:00Z",
  • "estimatedDate": "2022-04-03",
  • "dueFlightSeconds": 1000,
  • "dueApuSeconds": 1000,
  • "dueCycles": 100,
  • "dueLandings": 100,
  • "repeatFlightSeconds": 1000,
  • "toleranceFlightSeconds": 100,
  • "visibleToleranceFlightSeconds": 100,
  • "thresholdFlightSeconds": 10,
  • "repeatApuSeconds": 100,
  • "toleranceApuSeconds": 10,
  • "visibleToleranceApuSeconds": 10,
  • "thresholdApuSeconds": 1,
  • "repeatDays": 50,
  • "toleranceDays": 5,
  • "visibleToleranceDays": 5,
  • "thresholdDays": 2,
  • "repeatMonths": 50,
  • "toleranceMonths": 5,
  • "visibleToleranceMonths": 5,
  • "thresholdMonths": 2,
  • "repeatCycles": 40,
  • "toleranceCycles": 4,
  • "thresholdCycles": 2,
  • "repeatRemarks": "doing it again",
  • "partNumber": "abc-123",
  • "partSerial": "qwerty123",
  • "reference": "tgdbetg",
  • "ataChapter": 59,
  • "ataSection": 5,
  • "assembly": "string",
  • "customData": { },
  • "operatorReference": "456xyz",
  • "placardProcedureCompleted": true,
  • "operationalProcedureCompleted": true,
  • "crewActionable": true,
  • "serviceabilityLimiting": true,
  • "normalisedFlightSecondsDue": 48000,
  • "normalisedCyclesDue": 50,
  • "unitOfTime": "days",
  • "importedAt": "2022-02-02T09:08:00Z",
  • "editedBy": "999e0029-6811-4c9f-8e04-4bafe2de6111",
  • "eropsPrevented": false,
  • "placardNumber": "abc123",
  • "calendarDaysAmberLimit": 10,
  • "calendarDaysSecondsLimit": 129600,
  • "editedDate": "2022-04-02T17:08:00Z",
  • "campSyncDate": "2022-04-02T17:08:00Z",
  • "thirdPartyReferences": {
    },
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z"
}

Find aircraft type by ID

Returns an aircraft type based on ID

path Parameters
id
required
string <uuid>

ID of aircraft type requested

Responses

Response samples

Content type
application/json
{
  • "id": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "manufacturer": "TrustFlight",
  • "model": "EMB-505 Phenom 300",
  • "designator": "E55P",
  • "category": "land",
  • "engineCount": 2,
  • "engineType": "piston",
  • "weightCategory": "light",
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z"
}

Airports

Endpoints associated with Airports

Return a list of Airports

Return a list of Airports matching the given criteria

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

airportIds
Array of integers
Example: airportIds=123&airportIds=456

An array of Airport IDs to limit the returned Airports by

countryIso2
string
Example: countryIso2=GB

Limit the Airports returned by the iso2 code of a specific country

name
string
Example: name=aquino internat

Fuzzy matched (case insensitive) against Airport name

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Find airport by ID

Get the details of one Airport by its unique identifier

path Parameters
id
required
integer
Example: 8302

Trustflight ID of the Airport being queried

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Birmingham International Airport",
  • "airportType": "mediumAirport",
  • "icaoCode": "EGBB",
  • "iataCode": "BHX",
  • "gpsCode": "EGBB",
  • "localCode": "XXX",
  • "municipality": "Birmingham",
  • "region": "GB-ENG",
  • "country": "GB",
  • "continent": "NA",
  • "latitude": "string",
  • "longitude": "string",
  • "elevation": 327,
  • "scheduledService": true,
  • "website": "http://www.bhx.co.uk/",
  • "wikipedia": "https://en.wikipedia.org/wiki/Birmingham_International_Airport_(United_Kingdom)",
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z"
}

Find airport by ICAO code

Get the details of an airport by Icao code

path Parameters
icaoCode
required
string
Example: EGBB

ICAO code of airport being queried

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Birmingham International Airport",
  • "airportType": "mediumAirport",
  • "icaoCode": "EGBB",
  • "iataCode": "BHX",
  • "gpsCode": "EGBB",
  • "localCode": "XXX",
  • "municipality": "Birmingham",
  • "region": "GB-ENG",
  • "country": "GB",
  • "continent": "NA",
  • "latitude": "string",
  • "longitude": "string",
  • "elevation": 327,
  • "scheduledService": true,
  • "website": "http://www.bhx.co.uk/",
  • "wikipedia": "https://en.wikipedia.org/wiki/Birmingham_International_Airport_(United_Kingdom)",
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z"
}

Capabilities

Endpoints associated with Capabilities

List Capabilities

Returns all Capabilities

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Defects

Endpoints associated with Defects

List Defects for a Sector

Returns all Defects that belong to the Sector with the passed ID, ordered by dueDate ascending

path Parameters
id
required
string <uuid>

The id of the Sector to fetch all Defects for

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

defectTypes[]
Array of any
Default: "CAS&defectTypes[]=CDL&defectTypes[]=MEL&defectTypes[]=NEF&defectTypes[]=Other"
Items Enum: "CAS" "CDL" "MEL" "NEF" "Other"
Example: defectTypes[]=CAS&defectTypes[]=MEL

An array of defect types to filter the returned Defects by.

rectificationCategories[]
Array of any
Default: "A&rectificationCategories[]=ADVISORYONLY&rectificationCategories[]=B&rectificationCategories[]=C&rectificationCategories[]=D&rectificationCategories[]=NONDEFERRED"
Items Enum: "A" "ADVISORYONLY" "B" "C" "D" "NONDEFERRED"
Example: rectificationCategories[]=B&rectificationCategories[]=C

An array of rectification categories to filter the returned Defects by.

statuses[]
Array of any
Items Enum: "open" "resolved" "overdue" "deferral_pending" "resolution_pending"
Example: statuses[]=overdue&statuses[]=resolved

An array of statuses to filter the returned Defects by.

updatedAfter
string <date-time>
Example: updatedAfter=2022-02-14T11:08:00Z

Will only return records that have been updated at or after this datetime

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

List Defects for a TripUpdate

Returns all Defects that belong to the TripUpdate with the passed ID, ordered by dueDate ascending

path Parameters
id
required
string <uuid>

The id of the TripUpdate to fetch all Defects for

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

defectTypes[]
Array of any
Default: "CAS&defectTypes[]=CDL&defectTypes[]=MEL&defectTypes[]=NEF&defectTypes[]=Other"
Items Enum: "CAS" "CDL" "MEL" "NEF" "Other"
Example: defectTypes[]=CAS&defectTypes[]=MEL

An array of defect types to filter the returned Defects by.

rectificationCategories[]
Array of any
Default: "A&rectificationCategories[]=ADVISORYONLY&rectificationCategories[]=B&rectificationCategories[]=C&rectificationCategories[]=D&rectificationCategories[]=NONDEFERRED"
Items Enum: "A" "ADVISORYONLY" "B" "C" "D" "NONDEFERRED"
Example: rectificationCategories[]=B&rectificationCategories[]=C

An array of rectification categories to filter the returned Defects by.

statuses[]
Array of any
Items Enum: "open" "resolved" "overdue" "deferral_pending" "resolution_pending"
Example: statuses[]=overdue&statuses[]=resolved

An array of statuses to filter the returned Defects by.

updatedAfter
string <date-time>
Example: updatedAfter=2022-02-14T11:08:00Z

Will only return records that have been updated at or after this datetime

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Lists all defects

Lists all defects that meet specified criteria

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

aircraftIds[]
Array of strings <uuid> [ items <uuid > ]
Example: aircraftIds[]=41f10b92-0e8a-4eb4-a17f-c20e7f124999&aircraftIds[]=fdb77302-68a9-4ce1-a2d7-4b42b3b36dcd

An array of Aircraft IDs to limit the returned records by

defectTypes[]
Array of any
Default: "CAS&defectTypes[]=CDL&defectTypes[]=MEL&defectTypes[]=NEF&defectTypes[]=Other"
Items Enum: "CAS" "CDL" "MEL" "NEF" "Other"
Example: defectTypes[]=CAS&defectTypes[]=MEL

An array of defect types to filter the returned Defects by.

rectificationCategories[]
Array of any
Default: "A&rectificationCategories[]=ADVISORYONLY&rectificationCategories[]=B&rectificationCategories[]=C&rectificationCategories[]=D&rectificationCategories[]=NONDEFERRED"
Items Enum: "A" "ADVISORYONLY" "B" "C" "D" "NONDEFERRED"
Example: rectificationCategories[]=B&rectificationCategories[]=C

An array of rectification categories to filter the returned Defects by.

statuses[]
Array of any
Items Enum: "open" "resolved" "overdue" "deferral_pending" "resolution_pending"
Example: statuses[]=overdue&statuses[]=resolved

An array of statuses to filter the returned Defects by.

updatedAfter
string <date-time>
Example: updatedAfter=2022-02-14T11:08:00Z

Will only return records that have been updated at or after this datetime

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Lists all defects

Lists all defects that meet specified criteria

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

aircraftIds[]
Array of strings <uuid> [ items <uuid > ]
Example: aircraftIds[]=41f10b92-0e8a-4eb4-a17f-c20e7f124999&aircraftIds[]=fdb77302-68a9-4ce1-a2d7-4b42b3b36dcd

An array of Aircraft IDs to limit the returned records by

defectTypes[]
Array of any
Default: "CAS&defectTypes[]=CDL&defectTypes[]=MEL&defectTypes[]=NEF&defectTypes[]=Other"
Items Enum: "CAS" "CDL" "MEL" "NEF" "Other"
Example: defectTypes[]=CAS&defectTypes[]=MEL

An array of defect types to filter the returned Defects by.

rectificationCategories[]
Array of any
Default: "A&rectificationCategories[]=ADVISORYONLY&rectificationCategories[]=B&rectificationCategories[]=C&rectificationCategories[]=D&rectificationCategories[]=NONDEFERRED"
Items Enum: "A" "ADVISORYONLY" "B" "C" "D" "NONDEFERRED"
Example: rectificationCategories[]=B&rectificationCategories[]=C

An array of rectification categories to filter the returned Defects by.

statuses[]
Array of any
Items Enum: "open" "resolved" "overdue" "deferral_pending" "resolution_pending"
Example: statuses[]=overdue&statuses[]=resolved

An array of statuses to filter the returned Defects by.

updatedAfter
string <date-time>
Example: updatedAfter=2022-02-14T11:08:00Z

Will only return records that have been updated at or after this datetime

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Create a new Defect

Creates a new Defect

path Parameters
id
required
string <uuid>

The id of the Aircraft to create the Defect against

Request Body schema: application/json
required
tripEntryId
string <uuid>

The unique identifier of the TripUpdate or Trip to which the Defect belongs

intermittentFaultId
string or null

The intermittent fault from which this defect originated

sectorId
string <uuid>

The unique identifier for the Sector on which the Defect was identified

details
required
string

A text field for describing the nature of the defect

itemDescription
string

A text field for describing the nature of the defect

number
integer

The number of the Defect

raisedAt
required
string <date-time>

The UTC date-time at which the Defect was raised

reference
string

A reference by which the Defect can be identified

ataChapter
integer

The ATA chapter number

ataSection
integer

The ATA section number. Conditionally required when creating a defect with a deferral, or when deferring an existing defect that will be exported to a third-party system.

limitations
string

Limitations against the Defect

bookItemId
string <uuid>

The unique identifier of the Book Item to which the Defect belongs

bookItemType
string

The type of the book item - must be one of MelItem, CdlItem or NefItem

rectificationId
string <uuid>

The unique identifier of the Rectification to which the Defect belongs. If rectificationId is provided, then bookItemId must also be included, as the rectification must be associated with the specified book item.

placardProcedureCompleted
boolean
operationalProcedureCompleted
boolean
deferred
required
boolean
reportedById
string <uuid>
defectType
required
string
Enum: "MEL" "CDL" "CAS" "NEF" "Other"

The type of the Defect

rectificationCategory
required
string
Enum: "A" "B" "C" "D" "NONDEFERRED" "ADVISORYONLY"

The rectification category of the Defect. When the value is "A", you must include at least one of the following fields in the request: limitFlightSeconds, limitSeconds, limitFlightDays, limitCycles, limitFlights, limitCalendarDays, limitApuSeconds, limitOther.

serviceabilityLimiting
boolean

Whether the Defect impacts serviceability

limitFlightSeconds
integer

The flight seconds limit placed against the Defect. Added to the flight seconds of the aircraft at the date-time the Defect was raised to calculate the dueFlightSeconds of the Defect

limitSeconds
integer

The seconds limit placed against the Defect. Added to the the date-time the Defect was raised to calculate the dueDateTime of the Defect

limitFlightDays
integer

The flight days limit placed against the Defect. The number of flight days since the Defect was raised after which the Defect will go overdue

limitCycles
integer

The cycles limit placed against the Defect. Added to the airframe cycles of the aircraft at the date-time the Defect was raised to calculate the dueCycles of the Defect

limitFlights
integer

The flights limit placed against the Defect. Added to the airframe flights of the aircraft at the date-time the Defect was raised to calculate the dueFlights of the Defect

limitCalendarDays
integer

The calendar days limit placed against the Defect. Added to the date-time the Defect was raised to calculate the dueDate of the Defect

limitApuSeconds
integer

The apu seconds limit placed against the Defect. Added to the apu seconds of the aircraft at the date-time the Defect was raised to calculate the dueApuSeconds of the Defect

limitOther
string

A text field used to define another limit - not compared against any other field

deferApprovalReference
string
reasonToDefer
string
eropsPrevented
boolean
placardNumber
string
deferredAt
string <date-time>

The date-time(UTC) at which the Defect was deferred

deferralLicenceNumber
string
deferralApprovalNumber
string
deferredById
string <uuid>

The unique identifier of the User that deferred the Defect

deferUsing
string (DefectDeferUsing)
Enum: "crew_signoff" "deferral_approval_reference" "maintenance_signoff"
reportedByType
string (DefectReportedByType)
Enum: "pilot" "maintenance" "cabin"

Responses

Request samples

Content type
application/json
{
  • "tripEntryId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "intermittentFaultId": "21610b42-5e89-4eb4-c28b-a111aaabcdef",
  • "sectorId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "details": "Small dent in nearside panel",
  • "itemDescription": "Unknown how this occurred",
  • "number": 23,
  • "raisedAt": "2022-07-07T16:37:00Z",
  • "reference": "CFI3778",
  • "ataChapter": 22,
  • "ataSection": 22,
  • "limitations": "Aftermarket parts must not be used",
  • "bookItemId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "bookItemType": "MelItem",
  • "rectificationId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "placardProcedureCompleted": false,
  • "operationalProcedureCompleted": false,
  • "deferred": true,
  • "reportedById": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "defectType": "CAS",
  • "rectificationCategory": "A",
  • "serviceabilityLimiting": true,
  • "limitFlightSeconds": 3600,
  • "limitSeconds": 3600,
  • "limitFlightDays": 10,
  • "limitCycles": 20,
  • "limitFlights": 5,
  • "limitCalendarDays": 24,
  • "limitApuSeconds": 7200,
  • "limitOther": "Visual wear",
  • "deferApprovalReference": "WE9O44",
  • "reasonToDefer": "Unable to resolve on site",
  • "eropsPrevented": false,
  • "placardNumber": "333444",
  • "deferredAt": "2022-07-07T16:37:00Z",
  • "deferralLicenceNumber": "YYI987",
  • "deferralApprovalNumber": "YU765W",
  • "deferredById": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "deferUsing": "crew_signoff",
  • "reportedByType": "pilot"
}

Response samples

Content type
application/json
{
  • "id": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "aircraftId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "sectorId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "reportAirportId": "5b9v0b42-5e89-4eb4-c28b-a111xxxyyyzz",
  • "details": "Small dent in nearside panel",
  • "itemDescription": "Unknown how this occurred",
  • "number": 23,
  • "rectificationIntervalExtension": {
    },
  • "dueDate": "2022-07-07",
  • "dueDateTime": "2022-07-07T16:37:00Z",
  • "estimatedDate": "2022-07-07",
  • "raisedAt": "2022-07-07T16:37:00Z",
  • "dueFlightSeconds": 3600,
  • "dueApuSeconds": 3600,
  • "dueCycles": 50,
  • "dueLandings": 30,
  • "status": "open",
  • "reference": "CFI3778",
  • "ataChapter": 22,
  • "ataSection": 22,
  • "flightsDue": 4,
  • "limitations": "Aftermarket parts must not be used",
  • "bookItemId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "bookItemType": "MelItem",
  • "rectificationId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "placardProcedureCompleted": false,
  • "operationalProcedureCompleted": false,
  • "deferred": true,
  • "raisedFromId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "reportedById": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "source": "amos",
  • "importedAt": "2022-07-07T16:37:00Z",
  • "defectType": "CAS",
  • "rectificationCategory": "A",
  • "tripEntryId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "serviceabilityLimiting": true,
  • "limitFlightSeconds": 3600,
  • "limitSeconds": 3600,
  • "limitFlightDays": 10,
  • "limitCycles": 20,
  • "limitFlights": 5,
  • "limitCalendarDays": 24,
  • "limitApuSeconds": 7200,
  • "limitOther": "Visual wear",
  • "deferApprovalReference": "WE9O44",
  • "reasonToDefer": "Unable to resolve on site",
  • "editedById": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "editedDate": "2022-07-07T16:37:00Z",
  • "eropsPrevented": false,
  • "placardNumber": "333444",
  • "campSyncDate": "2022-07-07T16:37:00Z",
  • "thirdPartyReferences": {
    },
  • "deferredAt": "2022-07-07T16:37:00Z",
  • "deferralLicenceNumber": "YYI987",
  • "deferralApprovalNumber": "YU765W",
  • "deferredById": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "intermittentFaultId": "21610b42-5e89-4eb4-c28b-a111aaabcdef",
  • "reportedByType": "pilot",
  • "deferralRaisedAt": "2022-07-07T16:37:00Z",
  • "troubleshootingSteps": "Checked for leaks",
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z",
  • "deferUsing": "crew_signoff",
  • "bookItem": {
    },
  • "rectification": {
    }
}

Get a single Defect

Returns a Defect based on ID

Responses

Response samples

Content type
application/json
{
  • "id": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "aircraftId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "sectorId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "reportAirportId": "5b9a0b42-5e89-4eb4-c28b-a1112d33e1fa",
  • "resolutionAirportId": "5b9a0b42-5e89-4eb4-c28b-a11133acd5ad",
  • "details": "Small dent in nearside panel",
  • "itemDescription": "Unknown how this occurred",
  • "number": 23,
  • "rectificationIntervalExtension": {
    },
  • "dueDate": "2022-07-07",
  • "dueDateTime": "2022-07-07T16:37:00Z",
  • "estimatedDate": "2022-07-07",
  • "raisedAt": "2022-07-07T16:37:00Z",
  • "dueFlightSeconds": 3600,
  • "dueApuSeconds": 3600,
  • "dueCycles": 50,
  • "dueLandings": 30,
  • "status": "open",
  • "reference": "CFI3778",
  • "ataChapter": 22,
  • "ataSection": 22,
  • "flightsDue": 4,
  • "limitations": "Aftermarket parts must not be used",
  • "melItemId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "melRectificationId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "placardProcedureCompleted": false,
  • "operationalProcedureCompleted": false,
  • "deferred": true,
  • "raisedFromId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "reportedById": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "source": "amos",
  • "importedAt": "2022-07-07T16:37:00Z",
  • "defectType": "CAS",
  • "rectificationCategory": "A",
  • "tripEntryId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "serviceabilityLimiting": true,
  • "limitFlightSeconds": 3600,
  • "limitSeconds": 3600,
  • "limitFlightDays": 10,
  • "limitCycles": 20,
  • "limitFlights": 5,
  • "limitCalendarDays": 24,
  • "limitApuSeconds": 7200,
  • "limitOther": "Visual wear",
  • "deferApprovalReference": "WE9O44",
  • "reasonToDefer": "Unable to resolve on site",
  • "editedById": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "editedDate": "2022-07-07T16:37:00Z",
  • "eropsPrevented": false,
  • "placardNumber": "333444",
  • "campSyncDate": "2022-07-07T16:37:00Z",
  • "thirdPartyReferences": {
    },
  • "deferredAt": "2022-07-07T16:37:00Z",
  • "deferralLicenceNumber": "YYI987",
  • "deferralApprovalNumber": "YU765W",
  • "deferredById": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "intermittentFaultId": "21610b42-5e89-4eb4-c28b-a111aaabcdef",
  • "reportedByType": "pilot",
  • "deferralRaisedAt": "2022-07-07T16:37:00Z",
  • "troubleshootingSteps": "Checked for leaks",
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z",
  • "deferUsing": "crew_signoff"
}

Update a Defect

Updates a Defect based on ID

path Parameters
id
required
string <uuid>

The id of the Defect to update

Request Body schema: application/json
required
sectorId
string <uuid>

The unique identifier for the Sector on which the Defect was identified

details
required
string

A text field for describing the nature of the defect

itemDescription
string

A text field for describing the nature of the defect

number
integer

The number of the Defect

raisedAt
required
string <date-time>

The UTC date-time at which the Defect was raised

reference
string

A reference by which the Defect can be identified

ataChapter
integer

The ATA chapter number

ataSection
integer

The ATA section number. Conditionally required when creating a defect with a deferral, or when deferring an existing defect that will be exported to a third-party system.

limitations
string

Limitations against the Defect

melItemId
string <uuid>

The unique identifier of the MEL Item to which the Defect belongs

melRectificationId
string <uuid>

The unique identifier of the MEL Rectification to which the Defect belongs. If melRectificationId is provided, then melItemId must also be included, as the rectification must be associated with the specified MEL item.

placardProcedureCompleted
boolean
operationalProcedureCompleted
boolean
deferred
required
boolean
reportedById
string <uuid>
defectType
required
string
Enum: "MEL" "CDL" "CAS" "NEF" "Other"

The type of the Defect

rectificationCategory
required
string
Enum: "A" "B" "C" "D" "NONDEFERRED" "ADVISORYONLY"

The rectification category of the Defect. When the value is "A", you must include at least one of the following fields in the request: limitFlightSeconds, limitSeconds, limitFlightDays, limitCycles, limitFlights, limitCalendarDays, limitApuSeconds, limitOther.

tripEntryId
string <uuid>

The unique identifier of the TripUpdate or Trip to which the Defect belongs

serviceabilityLimiting
boolean

Whether the Defect impacts serviceability

limitFlightSeconds
integer

The flight seconds limit placed against the Defect. Added to the flight seconds of the aircraft at the date-time the Defect was raised to calculate the dueFlightSeconds of the Defect

limitSeconds
integer

The seconds limit placed against the Defect. Added to the the date-time the Defect was raised to calculate the dueDateTime of the Defect

limitFlightDays
integer

The flight days limit placed against the Defect. The number of flight days since the Defect was raised after which the Defect will go overdue

limitCycles
integer

The cycles limit placed against the Defect. Added to the airframe cycles of the aircraft at the date-time the Defect was raised to calculate the dueCycles of the Defect

limitFlights
integer

The flights limit placed against the Defect. Added to the airframe flights of the aircraft at the date-time the Defect was raised to calculate the dueFlights of the Defect

limitCalendarDays
integer

The calendar days limit placed against the Defect. Added to the date-time the Defect was raised to calculate the dueDate of the Defect

limitApuSeconds
integer

The apu seconds limit placed against the Defect. Added to the apu seconds of the aircraft at the date-time the Defect was raised to calculate the dueApuSeconds of the Defect

limitOther
string

A text field used to define another limit - not compared against any other field

deferApprovalReference
string
reasonToDefer
string
eropsPrevented
boolean
placardNumber
string
deferredAt
string <date-time>

The date-time(UTC) at which the Defect was deferred

deferralLicenceNumber
string
deferralApprovalNumber
string
deferredById
string <uuid>

The unique identifier of the User that deferred the Defect

intermittentFaultId
string or null

The intermittent fault from which this defect originated

deferUsing
string (DefectDeferUsing)
Enum: "crew_signoff" "deferral_approval_reference" "maintenance_signoff"
reportedByType
string (DefectReportedByType)
Enum: "pilot" "maintenance" "cabin"

Responses

Request samples

Content type
application/json
{
  • "sectorId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "details": "Small dent in nearside panel",
  • "itemDescription": "Unknown how this occurred",
  • "number": 23,
  • "raisedAt": "2022-07-07T16:37:00Z",
  • "reference": "CFI3778",
  • "ataChapter": 22,
  • "ataSection": 22,
  • "limitations": "Aftermarket parts must not be used",
  • "melItemId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "melRectificationId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "placardProcedureCompleted": false,
  • "operationalProcedureCompleted": false,
  • "deferred": true,
  • "reportedById": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "defectType": "CAS",
  • "rectificationCategory": "A",
  • "tripEntryId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "serviceabilityLimiting": true,
  • "limitFlightSeconds": 3600,
  • "limitSeconds": 3600,
  • "limitFlightDays": 10,
  • "limitCycles": 20,
  • "limitFlights": 5,
  • "limitCalendarDays": 24,
  • "limitApuSeconds": 7200,
  • "limitOther": "Visual wear",
  • "deferApprovalReference": "WE9O44",
  • "reasonToDefer": "Unable to resolve on site",
  • "eropsPrevented": false,
  • "placardNumber": "333444",
  • "deferredAt": "2022-07-07T16:37:00Z",
  • "deferralLicenceNumber": "YYI987",
  • "deferralApprovalNumber": "YU765W",
  • "deferredById": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "intermittentFaultId": "21610b42-5e89-4eb4-c28b-a111aaabcdef",
  • "deferUsing": "crew_signoff",
  • "reportedByType": "pilot"
}

Response samples

Content type
application/json
{
  • "id": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "aircraftId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "sectorId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "reportAirportId": "5b9a0b42-5e89-4eb4-c28b-a1112d33e1fa",
  • "resolutionAirportId": "5b9a0b42-5e89-4eb4-c28b-a11133acd5ad",
  • "details": "Small dent in nearside panel",
  • "itemDescription": "Unknown how this occurred",
  • "number": 23,
  • "rectificationIntervalExtension": {
    },
  • "dueDate": "2022-07-07",
  • "dueDateTime": "2022-07-07T16:37:00Z",
  • "estimatedDate": "2022-07-07",
  • "raisedAt": "2022-07-07T16:37:00Z",
  • "dueFlightSeconds": 3600,
  • "dueApuSeconds": 3600,
  • "dueCycles": 50,
  • "dueLandings": 30,
  • "status": "open",
  • "reference": "CFI3778",
  • "ataChapter": 22,
  • "ataSection": 22,
  • "flightsDue": 4,
  • "limitations": "Aftermarket parts must not be used",
  • "melItemId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "melRectificationId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "placardProcedureCompleted": false,
  • "operationalProcedureCompleted": false,
  • "deferred": true,
  • "raisedFromId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "reportedById": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "source": "amos",
  • "importedAt": "2022-07-07T16:37:00Z",
  • "defectType": "CAS",
  • "rectificationCategory": "A",
  • "tripEntryId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "serviceabilityLimiting": true,
  • "limitFlightSeconds": 3600,
  • "limitSeconds": 3600,
  • "limitFlightDays": 10,
  • "limitCycles": 20,
  • "limitFlights": 5,
  • "limitCalendarDays": 24,
  • "limitApuSeconds": 7200,
  • "limitOther": "Visual wear",
  • "deferApprovalReference": "WE9O44",
  • "reasonToDefer": "Unable to resolve on site",
  • "editedById": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "editedDate": "2022-07-07T16:37:00Z",
  • "eropsPrevented": false,
  • "placardNumber": "333444",
  • "campSyncDate": "2022-07-07T16:37:00Z",
  • "thirdPartyReferences": {
    },
  • "deferredAt": "2022-07-07T16:37:00Z",
  • "deferralLicenceNumber": "YYI987",
  • "deferralApprovalNumber": "YU765W",
  • "deferredById": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "intermittentFaultId": "21610b42-5e89-4eb4-c28b-a111aaabcdef",
  • "reportedByType": "pilot",
  • "deferralRaisedAt": "2022-07-07T16:37:00Z",
  • "troubleshootingSteps": "Checked for leaks",
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z",
  • "deferUsing": "crew_signoff"
}

Delete a Defect

Deletes a Defect based on ID

path Parameters
id
required
string <uuid>

The id of the Defect to delete

Responses

Response samples

Content type
application/problem+json
Example
{}

Get a single Defect

Returns a Defect based on ID

path Parameters
id
required
string <uuid>
Example: dc5e143d-817f-4287-bb44-2176c6d6c64c

The id of the Defect

query Parameters
includeBookItem
boolean
Default: false

Include the book item details in the response. If set to true, response time may be slower.

includeRectification
boolean
Default: false

Include the rectification details in the response. If set to true, response time may be slower.

Responses

Response samples

Content type
application/json
{
  • "id": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "aircraftId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "sectorId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "reportAirportId": "5b9v0b42-5e89-4eb4-c28b-a111xxxyyyzz",
  • "details": "Small dent in nearside panel",
  • "itemDescription": "Unknown how this occurred",
  • "number": 23,
  • "rectificationIntervalExtension": {
    },
  • "dueDate": "2022-07-07",
  • "dueDateTime": "2022-07-07T16:37:00Z",
  • "estimatedDate": "2022-07-07",
  • "raisedAt": "2022-07-07T16:37:00Z",
  • "dueFlightSeconds": 3600,
  • "dueApuSeconds": 3600,
  • "dueCycles": 50,
  • "dueLandings": 30,
  • "status": "open",
  • "reference": "CFI3778",
  • "ataChapter": 22,
  • "ataSection": 22,
  • "flightsDue": 4,
  • "limitations": "Aftermarket parts must not be used",
  • "bookItemId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "bookItemType": "MelItem",
  • "rectificationId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "placardProcedureCompleted": false,
  • "operationalProcedureCompleted": false,
  • "deferred": true,
  • "raisedFromId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "reportedById": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "source": "amos",
  • "importedAt": "2022-07-07T16:37:00Z",
  • "defectType": "CAS",
  • "rectificationCategory": "A",
  • "tripEntryId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "serviceabilityLimiting": true,
  • "limitFlightSeconds": 3600,
  • "limitSeconds": 3600,
  • "limitFlightDays": 10,
  • "limitCycles": 20,
  • "limitFlights": 5,
  • "limitCalendarDays": 24,
  • "limitApuSeconds": 7200,
  • "limitOther": "Visual wear",
  • "deferApprovalReference": "WE9O44",
  • "reasonToDefer": "Unable to resolve on site",
  • "editedById": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "editedDate": "2022-07-07T16:37:00Z",
  • "eropsPrevented": false,
  • "placardNumber": "333444",
  • "campSyncDate": "2022-07-07T16:37:00Z",
  • "thirdPartyReferences": {
    },
  • "deferredAt": "2022-07-07T16:37:00Z",
  • "deferralLicenceNumber": "YYI987",
  • "deferralApprovalNumber": "YU765W",
  • "deferredById": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "intermittentFaultId": "21610b42-5e89-4eb4-c28b-a111aaabcdef",
  • "reportedByType": "pilot",
  • "deferralRaisedAt": "2022-07-07T16:37:00Z",
  • "troubleshootingSteps": "Checked for leaks",
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z",
  • "deferUsing": "crew_signoff",
  • "bookItem": {
    },
  • "rectification": {
    }
}

Update a Defect

Updates a Defect based on ID

path Parameters
id
required
string <uuid>

The id of the Defect to update

Request Body schema: application/json
required
sectorId
string <uuid>

The unique identifier for the Sector on which the Defect was identified

details
string

A text field for describing the nature of the defect

itemDescription
string

A text field for describing the nature of the defect

number
integer

The number of the Defect

raisedAt
string <date-time>

The UTC date-time at which the Defect was raised

reference
string

A reference by which the Defect can be identified

ataChapter
integer

The ATA chapter number

ataSection
integer

The ATA section number. Conditionally required when creating a defect with a deferral, or when deferring an existing defect that will be exported to a third-party system.

limitations
string

Limitations against the Defect

bookItemId
string <uuid>

The unique identifier of the Book Item to which the Defect belongs

bookItemType
string

The type of the book item - must be one of MelItem, CdlItem or NefItem

rectificationId
string <uuid>

The unique identifier of the Rectification to which the Defect belongs. If rectificationId is provided, then bookItemId must also be included, as the rectification must be associated with the specified book item.

placardProcedureCompleted
boolean
operationalProcedureCompleted
boolean
deferred
boolean
reportedById
string <uuid>
defectType
string
Enum: "MEL" "CDL" "CAS" "NEF" "Other"

The type of the Defect

rectificationCategory
string
Enum: "A" "B" "C" "D" "NONDEFERRED" "ADVISORYONLY"

The rectification category of the Defect. When the value is "A", you must include at least one of the following fields in the request: limitFlightSeconds, limitSeconds, limitFlightDays, limitCycles, limitFlights, limitCalendarDays, limitApuSeconds, limitOther.

serviceabilityLimiting
boolean

Whether the Defect impacts serviceability

limitFlightSeconds
integer

The flight seconds limit placed against the Defect. Added to the flight seconds of the aircraft at the date-time the Defect was raised to calculate the dueFlightSeconds of the Defect

limitSeconds
integer

The seconds limit placed against the Defect. Added to the the date-time the Defect was raised to calculate the dueDateTime of the Defect

limitFlightDays
integer

The flight days limit placed against the Defect. The number of flight days since the Defect was raised after which the Defect will go overdue

limitCycles
integer

The cycles limit placed against the Defect. Added to the airframe cycles of the aircraft at the date-time the Defect was raised to calculate the dueCycles of the Defect

limitFlights
integer

The flights limit placed against the Defect. Added to the airframe flights of the aircraft at the date-time the Defect was raised to calculate the dueFlights of the Defect

limitCalendarDays
integer

The calendar days limit placed against the Defect. Added to the date-time the Defect was raised to calculate the dueDate of the Defect

limitApuSeconds
integer

The apu seconds limit placed against the Defect. Added to the apu seconds of the aircraft at the date-time the Defect was raised to calculate the dueApuSeconds of the Defect

limitOther
string

A text field used to define another limit - not compared against any other field

deferApprovalReference
string
reasonToDefer
string
eropsPrevented
boolean
placardNumber
string
deferredAt
string <date-time>

The date-time(UTC) at which the Defect was deferred

deferralLicenceNumber
string
deferralApprovalNumber
string
deferredById
string <uuid>

The unique identifier of the User that deferred the Defect

deferUsing
string (DefectDeferUsing)
Enum: "crew_signoff" "deferral_approval_reference" "maintenance_signoff"
reportedByType
string (DefectReportedByType)
Enum: "pilot" "maintenance" "cabin"

Responses

Request samples

Content type
application/json
{
  • "sectorId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "details": "Small dent in nearside panel",
  • "itemDescription": "Unknown how this occurred",
  • "number": 23,
  • "raisedAt": "2022-07-07T16:37:00Z",
  • "reference": "CFI3778",
  • "ataChapter": 22,
  • "ataSection": 22,
  • "limitations": "Aftermarket parts must not be used",
  • "bookItemId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "bookItemType": "MelItem",
  • "rectificationId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "placardProcedureCompleted": false,
  • "operationalProcedureCompleted": false,
  • "deferred": true,
  • "reportedById": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "defectType": "CAS",
  • "rectificationCategory": "A",
  • "serviceabilityLimiting": true,
  • "limitFlightSeconds": 3600,
  • "limitSeconds": 3600,
  • "limitFlightDays": 10,
  • "limitCycles": 20,
  • "limitFlights": 5,
  • "limitCalendarDays": 24,
  • "limitApuSeconds": 7200,
  • "limitOther": "Visual wear",
  • "deferApprovalReference": "WE9O44",
  • "reasonToDefer": "Unable to resolve on site",
  • "eropsPrevented": false,
  • "placardNumber": "333444",
  • "deferredAt": "2022-07-07T16:37:00Z",
  • "deferralLicenceNumber": "YYI987",
  • "deferralApprovalNumber": "YU765W",
  • "deferredById": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "deferUsing": "crew_signoff",
  • "reportedByType": "pilot"
}

Response samples

Content type
application/json
{
  • "id": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "aircraftId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "sectorId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "reportAirportId": "5b9v0b42-5e89-4eb4-c28b-a111xxxyyyzz",
  • "details": "Small dent in nearside panel",
  • "itemDescription": "Unknown how this occurred",
  • "number": 23,
  • "rectificationIntervalExtension": {
    },
  • "dueDate": "2022-07-07",
  • "dueDateTime": "2022-07-07T16:37:00Z",
  • "estimatedDate": "2022-07-07",
  • "raisedAt": "2022-07-07T16:37:00Z",
  • "dueFlightSeconds": 3600,
  • "dueApuSeconds": 3600,
  • "dueCycles": 50,
  • "dueLandings": 30,
  • "status": "open",
  • "reference": "CFI3778",
  • "ataChapter": 22,
  • "ataSection": 22,
  • "flightsDue": 4,
  • "limitations": "Aftermarket parts must not be used",
  • "bookItemId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "bookItemType": "MelItem",
  • "rectificationId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "placardProcedureCompleted": false,
  • "operationalProcedureCompleted": false,
  • "deferred": true,
  • "raisedFromId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "reportedById": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "source": "amos",
  • "importedAt": "2022-07-07T16:37:00Z",
  • "defectType": "CAS",
  • "rectificationCategory": "A",
  • "tripEntryId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "serviceabilityLimiting": true,
  • "limitFlightSeconds": 3600,
  • "limitSeconds": 3600,
  • "limitFlightDays": 10,
  • "limitCycles": 20,
  • "limitFlights": 5,
  • "limitCalendarDays": 24,
  • "limitApuSeconds": 7200,
  • "limitOther": "Visual wear",
  • "deferApprovalReference": "WE9O44",
  • "reasonToDefer": "Unable to resolve on site",
  • "editedById": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "editedDate": "2022-07-07T16:37:00Z",
  • "eropsPrevented": false,
  • "placardNumber": "333444",
  • "campSyncDate": "2022-07-07T16:37:00Z",
  • "thirdPartyReferences": {
    },
  • "deferredAt": "2022-07-07T16:37:00Z",
  • "deferralLicenceNumber": "YYI987",
  • "deferralApprovalNumber": "YU765W",
  • "deferredById": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "intermittentFaultId": "21610b42-5e89-4eb4-c28b-a111aaabcdef",
  • "reportedByType": "pilot",
  • "deferralRaisedAt": "2022-07-07T16:37:00Z",
  • "troubleshootingSteps": "Checked for leaks",
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z",
  • "deferUsing": "crew_signoff",
  • "bookItem": {
    },
  • "rectification": {
    }
}

Delete a Defect

Deletes a Defect based on ID

path Parameters
id
required
string <uuid>

The id of the Defect to delete

Responses

Response samples

Content type
application/problem+json
Example
{}

Add a release against defect

Creates release against defect with passed id

path Parameters
id
required
string <uuid>

The id of the Defect

Request Body schema: application/json
required
companyEmail
string
licenceNumber
string
firstName
string
lastName
string
reporterFirstName
string
reporterLastName
string
approvalNumber
string
companyName
string
reference
string
date
string <date>
signeeType
string (SigneeType)
Enum: "crewDetails" "engineerDetails" "crsDocument"
approverFirstName
string
approverLastName
string

Responses

Request samples

Content type
application/json
{
  • "companyEmail": "company@example.com",
  • "licenceNumber": "Example-123",
  • "firstName": "John",
  • "lastName": "Smith",
  • "reporterFirstName": "John",
  • "reporterLastName": "Smith",
  • "approvalNumber": "Example-123",
  • "companyName": "ExampleCompany",
  • "reference": "Example-123",
  • "date": "2022-07-07",
  • "signeeType": "crewDetails",
  • "approverFirstName": "John",
  • "approverLastName": "Smith"
}

Response samples

Content type
application/json
{
  • "id": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "aircraftId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "operatorId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "workpackId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "openDefectIds": [
    ],
  • "additionalItems": [
    ],
  • "mxItemIds": [
    ],
  • "date": "2022-07-07T15:37:00Z",
  • "companyName": "ExampleCompany",
  • "approvalNumber": "Example-123",
  • "firstName": "John",
  • "lastName": "Smith",
  • "licenceNumber": "Example-123",
  • "companyEmail": "company@example.com",
  • "customData": { },
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z",
  • "reference": "Example-123",
  • "reporterFirstName": "John",
  • "reporterLastName": "Smith",
  • "approverFirstName": "John",
  • "approverLastName": "Smith",
  • "signeeType": "crewDetails",
  • "attachments": [
    ],
  • "approvalReleaseRequired": false,
  • "approvedById": "01610b42-5e89-4eb4-a17f-c20e7f7d2676"
}

List Defects for an Aircraft

Returns all Defects that belong to the Aircraft with the passed ID, ordered by dueDate ascending

path Parameters
id
required
string <uuid>

The id of the Aircraft to fetch all Defects for

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

defectTypes[]
Array of any
Default: "CAS&defectTypes[]=CDL&defectTypes[]=MEL&defectTypes[]=NEF&defectTypes[]=Other"
Items Enum: "CAS" "CDL" "MEL" "NEF" "Other"
Example: defectTypes[]=CAS&defectTypes[]=MEL

An array of defect types to filter the returned Defects by.

rectificationCategories[]
Array of any
Default: "A&rectificationCategories[]=ADVISORYONLY&rectificationCategories[]=B&rectificationCategories[]=C&rectificationCategories[]=D&rectificationCategories[]=NONDEFERRED"
Items Enum: "A" "ADVISORYONLY" "B" "C" "D" "NONDEFERRED"
Example: rectificationCategories[]=B&rectificationCategories[]=C

An array of rectification categories to filter the returned Defects by.

statuses[]
Array of any
Items Enum: "open" "resolved" "overdue" "deferral_pending" "resolution_pending"
Example: statuses[]=overdue&statuses[]=resolved

An array of statuses to filter the returned Defects by.

updatedAfter
string <date-time>
Example: updatedAfter=2022-02-14T11:08:00Z

Will only return records that have been updated at or after this datetime

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Create a Defect

Creates a Defect

path Parameters
id
required
string <uuid>

The id of the Aircraft to create the Defect against

Request Body schema: application/json
required
sectorId
string <uuid>

The unique identifier for the Sector on which the Defect was identified

details
required
string

A text field for describing the nature of the defect

itemDescription
string

A text field for describing the nature of the defect

number
integer

The number of the Defect

raisedAt
required
string <date-time>

The UTC date-time at which the Defect was raised

reference
string

A reference by which the Defect can be identified

ataChapter
integer

The ATA chapter number

ataSection
integer

The ATA section number. Conditionally required when creating a defect with a deferral, or when deferring an existing defect that will be exported to a third-party system.

limitations
string

Limitations against the Defect

melItemId
string <uuid>

The unique identifier of the MEL Item to which the Defect belongs

melRectificationId
string <uuid>

The unique identifier of the MEL Rectification to which the Defect belongs. If melRectificationId is provided, then melItemId must also be included, as the rectification must be associated with the specified MEL item.

placardProcedureCompleted
boolean
operationalProcedureCompleted
boolean
deferred
required
boolean
reportedById
string <uuid>
defectType
required
string
Enum: "MEL" "CDL" "CAS" "NEF" "Other"

The type of the Defect

rectificationCategory
required
string
Enum: "A" "B" "C" "D" "NONDEFERRED" "ADVISORYONLY"

The rectification category of the Defect. When the value is "A", you must include at least one of the following fields in the request: limitFlightSeconds, limitSeconds, limitFlightDays, limitCycles, limitFlights, limitCalendarDays, limitApuSeconds, limitOther.

tripEntryId
string <uuid>

The unique identifier of the TripUpdate or Trip to which the Defect belongs

serviceabilityLimiting
boolean

Whether the Defect impacts serviceability

limitFlightSeconds
integer

The flight seconds limit placed against the Defect. Added to the flight seconds of the aircraft at the date-time the Defect was raised to calculate the dueFlightSeconds of the Defect

limitSeconds
integer

The seconds limit placed against the Defect. Added to the the date-time the Defect was raised to calculate the dueDateTime of the Defect

limitFlightDays
integer

The flight days limit placed against the Defect. The number of flight days since the Defect was raised after which the Defect will go overdue

limitCycles
integer

The cycles limit placed against the Defect. Added to the airframe cycles of the aircraft at the date-time the Defect was raised to calculate the dueCycles of the Defect

limitFlights
integer

The flights limit placed against the Defect. Added to the airframe flights of the aircraft at the date-time the Defect was raised to calculate the dueFlights of the Defect

limitCalendarDays
integer

The calendar days limit placed against the Defect. Added to the date-time the Defect was raised to calculate the dueDate of the Defect

limitApuSeconds
integer

The apu seconds limit placed against the Defect. Added to the apu seconds of the aircraft at the date-time the Defect was raised to calculate the dueApuSeconds of the Defect

limitOther
string

A text field used to define another limit - not compared against any other field

deferApprovalReference
string
reasonToDefer
string
eropsPrevented
boolean
placardNumber
string
deferredAt
string <date-time>

The date-time(UTC) at which the Defect was deferred

deferralLicenceNumber
string
deferralApprovalNumber
string
deferredById
string <uuid>

The unique identifier of the User that deferred the Defect

intermittentFaultId
string or null

The intermittent fault from which this defect originated

deferUsing
string (DefectDeferUsing)
Enum: "crew_signoff" "deferral_approval_reference" "maintenance_signoff"
reportedByType
string (DefectReportedByType)
Enum: "pilot" "maintenance" "cabin"

Responses

Request samples

Content type
application/json
{
  • "sectorId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "details": "Small dent in nearside panel",
  • "itemDescription": "Unknown how this occurred",
  • "number": 23,
  • "raisedAt": "2022-07-07T16:37:00Z",
  • "reference": "CFI3778",
  • "ataChapter": 22,
  • "ataSection": 22,
  • "limitations": "Aftermarket parts must not be used",
  • "melItemId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "melRectificationId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "placardProcedureCompleted": false,
  • "operationalProcedureCompleted": false,
  • "deferred": true,
  • "reportedById": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "defectType": "CAS",
  • "rectificationCategory": "A",
  • "tripEntryId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "serviceabilityLimiting": true,
  • "limitFlightSeconds": 3600,
  • "limitSeconds": 3600,
  • "limitFlightDays": 10,
  • "limitCycles": 20,
  • "limitFlights": 5,
  • "limitCalendarDays": 24,
  • "limitApuSeconds": 7200,
  • "limitOther": "Visual wear",
  • "deferApprovalReference": "WE9O44",
  • "reasonToDefer": "Unable to resolve on site",
  • "eropsPrevented": false,
  • "placardNumber": "333444",
  • "deferredAt": "2022-07-07T16:37:00Z",
  • "deferralLicenceNumber": "YYI987",
  • "deferralApprovalNumber": "YU765W",
  • "deferredById": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "intermittentFaultId": "21610b42-5e89-4eb4-c28b-a111aaabcdef",
  • "deferUsing": "crew_signoff",
  • "reportedByType": "pilot"
}

Response samples

Content type
application/json
{
  • "id": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "aircraftId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "sectorId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "reportAirportId": "5b9v0b42-5e89-4eb4-c28b-a111xxxyyyzz",
  • "details": "Small dent in nearside panel",
  • "itemDescription": "Unknown how this occurred",
  • "number": 23,
  • "rectificationIntervalExtension": {
    },
  • "dueDate": "2022-07-07",
  • "dueDateTime": "2022-07-07T16:37:00Z",
  • "estimatedDate": "2022-07-07",
  • "raisedAt": "2022-07-07T16:37:00Z",
  • "dueFlightSeconds": 3600,
  • "dueApuSeconds": 3600,
  • "dueCycles": 50,
  • "dueLandings": 30,
  • "status": "open",
  • "reference": "CFI3778",
  • "ataChapter": 22,
  • "ataSection": 22,
  • "flightsDue": 4,
  • "limitations": "Aftermarket parts must not be used",
  • "bookItemId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "bookItemType": "MelItem",
  • "rectificationId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "placardProcedureCompleted": false,
  • "operationalProcedureCompleted": false,
  • "deferred": true,
  • "raisedFromId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "reportedById": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "source": "amos",
  • "importedAt": "2022-07-07T16:37:00Z",
  • "defectType": "CAS",
  • "rectificationCategory": "A",
  • "tripEntryId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "serviceabilityLimiting": true,
  • "limitFlightSeconds": 3600,
  • "limitSeconds": 3600,
  • "limitFlightDays": 10,
  • "limitCycles": 20,
  • "limitFlights": 5,
  • "limitCalendarDays": 24,
  • "limitApuSeconds": 7200,
  • "limitOther": "Visual wear",
  • "deferApprovalReference": "WE9O44",
  • "reasonToDefer": "Unable to resolve on site",
  • "editedById": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "editedDate": "2022-07-07T16:37:00Z",
  • "eropsPrevented": false,
  • "placardNumber": "333444",
  • "campSyncDate": "2022-07-07T16:37:00Z",
  • "thirdPartyReferences": {
    },
  • "deferredAt": "2022-07-07T16:37:00Z",
  • "deferralLicenceNumber": "YYI987",
  • "deferralApprovalNumber": "YU765W",
  • "deferredById": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "intermittentFaultId": "21610b42-5e89-4eb4-c28b-a111aaabcdef",
  • "reportedByType": "pilot",
  • "deferralRaisedAt": "2022-07-07T16:37:00Z",
  • "troubleshootingSteps": "Checked for leaks",
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z",
  • "deferUsing": "crew_signoff",
  • "bookItem": {
    },
  • "rectification": {
    }
}

DeiceEvents

Endpoints associated with DeiceEvents

Get a single DeiceEvent

Returns a DeiceEvent based on ID

path Parameters
id
required
string <uuid>
Example: 41f10b92-0e8a-4eb4-a17f-c20e7f124888

The id of the DeiceEvent

Responses

Response samples

Content type
application/json
{
  • "id": "71f10b92-0e8a-4eb4-a17f-c20e7f124e1a",
  • "sectorId": "71f10b92-0e8a-4eb4-a17f-c20e7f124999",
  • "startTime": "2022-07-07T13:37:00Z",
  • "endTime": "2022-07-07T13:37:00Z",
  • "fluidRatioLeft": 50,
  • "fluidRatioRight": 50,
  • "quantity": 100,
  • "fluidType": "I",
  • "holdoverSeconds": 100,
  • "attachments": [
    ],
  • "createdAt": "2022-02-02T11:08:00Z",
  • "updatedAt": "2022-03-03T13:09:00Z"
}

Find deice events by aircraft ID

Returns deice events for a given aircraft ID

path Parameters
id
required
string <uuid>
Example: 41f10b92-0e8a-4eb4-a17f-c20e7f124999

ID of aircraft to use

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Find deice events by sector ID

Returns deice events for a given sector ID

path Parameters
id
required
string <uuid>
Example: 41f10b92-0e8a-4eb4-a17f-c20e7f124555

ID of sector to use

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

FluidUplifts

Endpoints associated with FluidUplifts

List all FluidUplifts

Lists all fluid uplifts that meet specified criteria

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

aircraftIds[]
Array of strings <uuid> [ items <uuid > ]
Example: aircraftIds[]=41f10b92-0e8a-4eb4-a17f-c20e7f124999&aircraftIds[]=fdb77302-68a9-4ce1-a2d7-4b42b3b36dcd

An array of Aircraft IDs to limit the returned records by

updatedAfter
string <date-time>
Example: updatedAfter=2022-02-14T11:08:00Z

Will only return records that have been updated at or after this datetime

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Lists FluidUplifts for an MxCheck

Returns all FluidUplifts that belong to the MxCheck with the passed ID

path Parameters
id
required
string <uuid>

The id of the MxCheck to fetch all FluidUplifts for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

FuelUplifts

Endpoints associated with FuelUplifts

List all FuelUplifts

Lists all fuel uplifts that meet specified criteria

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

aircraftIds[]
Array of strings <uuid> [ items <uuid > ]
Example: aircraftIds[]=41f10b92-0e8a-4eb4-a17f-c20e7f124999&aircraftIds[]=fdb77302-68a9-4ce1-a2d7-4b42b3b36dcd

An array of Aircraft IDs to limit the returned records by

updatedAfter
string <date-time>
Example: updatedAfter=2022-02-14T11:08:00Z

Will only return records that have been updated at or after this datetime

associatedRecordType
string
Enum: "Flight" "MxCheck" "TripUpdate"
Example: associatedRecordType=Flight

Filter fuel uplifts by their associated record type. Must be used together with associatedRecordIds.

associatedRecordIds[]
Array of strings <uuid> [ items <uuid > ]
Example: associatedRecordIds[]=41f10b92-0e8a-4eb4-a17f-c20e7f124999

Filter fuel uplifts by an array of associated record IDs with type associatedRecordType. Must be used together with associatedRecordType.

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Mels

Endpoints associated with Mels

Add a new Mel

Add a new Mel (Minimum Equipment List)

Request Body schema: application/json
required
aircraftId
string <uuid>
status
string
Enum: "draft" "active"
source
string
Array of objects (MelItem)

Responses

Request samples

Content type
application/json
{
  • "aircraftId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "status": "draft",
  • "source": "Received 1st April 2020 from CAA",
  • "melItems": [
    ]
}

Response samples

Content type
application/json
{
  • "createdId": "6e910b42-5e89-4eb4-c28b-a111aaabbbcc"
}

Get mel item by ID

Returns a specific MEL item based on its ID

Authorizations:
None
path Parameters
id
required
string

The unique identifier of the MEL item

Responses

Response samples

Content type
application/json
{
  • "id": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "melId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "pageNumber": 1,
  • "chapterNumber": 2,
  • "sectionNumber": 3,
  • "subsectionNumber": 4,
  • "title": "Some item description",
  • "melRectifications": [
    ],
  • "parentId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "subsubsection": "1.1.1.1",
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z"
}

MxChecks

Endpoints associated with MxChecks

Get all MxChecks for a Sector

Returns all MxChecks that belong to the Sector with the passed ID

path Parameters
id
required
string <uuid>

The id of the Sector to fetch all MxChecks for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List all MxChecks

Lists all MxChecks that meet the specified criteria

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

aircraftIds[]
Array of strings <uuid> [ items <uuid > ]
Example: aircraftIds[]=41f10b92-0e8a-4eb4-a17f-c20e7f124999&aircraftIds[]=fdb77302-68a9-4ce1-a2d7-4b42b3b36dcd

An array of Aircraft IDs to limit the returned records by

updatedAfter
string <date-time>
Example: updatedAfter=2022-02-14T11:08:00Z

Will only return records that have been updated at or after this datetime

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Lists FluidUplifts for an MxCheck

Returns all FluidUplifts that belong to the MxCheck with the passed ID

path Parameters
id
required
string <uuid>

The id of the MxCheck to fetch all FluidUplifts for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Operators

An organization who engages in the provision of transport services by aircraft

Returns all Operators that the current request has access to

List all accessible Operators

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns all Aircraft that belong the the requested Operator

List Aircraft by Operator ID

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

registration
string
Example: registration=2-TRA

Fuzzy matched (case insensitive) against Aircraft registration

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Returns all User that belong the the requested Operator

List User by Operator ID

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

email
string
Example: email=@example.com

Filter users by a full or partial email address

position
Array of strings (UserPosition)
Default: "Admin&position=Pilot&position=OpsController&position=Camo&position=Crew&position=Engineer&position=ReliefPilot&position=FlightAttendant"
Items Enum: "Admin" "Pilot" "OpsController" "Camo" "Crew" "Engineer" "ReliefPilot" "FlightAttendant"
Example: position=Pilot&position=ReliefPilot

Not yet available - Filter users by their position

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Releases

Release is created when an item is signed off (released/closed).

Add a release against defect

Creates release against defect with passed id

path Parameters
id
required
string <uuid>

The id of the Defect

Request Body schema: application/json
required
companyEmail
string
licenceNumber
string
firstName
string
lastName
string
reporterFirstName
string
reporterLastName
string
approvalNumber
string
companyName
string
reference
string
date
string <date>
signeeType
string (SigneeType)
Enum: "crewDetails" "engineerDetails" "crsDocument"
approverFirstName
string
approverLastName
string

Responses

Request samples

Content type
application/json
{
  • "companyEmail": "company@example.com",
  • "licenceNumber": "Example-123",
  • "firstName": "John",
  • "lastName": "Smith",
  • "reporterFirstName": "John",
  • "reporterLastName": "Smith",
  • "approvalNumber": "Example-123",
  • "companyName": "ExampleCompany",
  • "reference": "Example-123",
  • "date": "2022-07-07",
  • "signeeType": "crewDetails",
  • "approverFirstName": "John",
  • "approverLastName": "Smith"
}

Response samples

Content type
application/json
{
  • "id": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "aircraftId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "operatorId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "workpackId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "openDefectIds": [
    ],
  • "additionalItems": [
    ],
  • "mxItemIds": [
    ],
  • "date": "2022-07-07T15:37:00Z",
  • "companyName": "ExampleCompany",
  • "approvalNumber": "Example-123",
  • "firstName": "John",
  • "lastName": "Smith",
  • "licenceNumber": "Example-123",
  • "companyEmail": "company@example.com",
  • "customData": { },
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z",
  • "reference": "Example-123",
  • "reporterFirstName": "John",
  • "reporterLastName": "Smith",
  • "approverFirstName": "John",
  • "approverLastName": "Smith",
  • "signeeType": "crewDetails",
  • "attachments": [
    ],
  • "approvalReleaseRequired": false,
  • "approvedById": "01610b42-5e89-4eb4-a17f-c20e7f7d2676"
}

Lists all releases

Lists all releases that meet specified criteria

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

updatedAfter
string <date-time>
Example: updatedAfter=2022-02-14T11:08:00Z

Will only return records that have been updated at or after this datetime

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Find release by ID

Returns an release based on ID

path Parameters
id
required
string <uuid>

ID of release to use

Responses

Response samples

Content type
application/json
{
  • "id": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "aircraftId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "operatorId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "workpackId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "openDefectIds": [
    ],
  • "additionalItems": [
    ],
  • "mxItemIds": [
    ],
  • "date": "2022-07-07T15:37:00Z",
  • "companyName": "ExampleCompany",
  • "approvalNumber": "Example-123",
  • "firstName": "John",
  • "lastName": "Smith",
  • "licenceNumber": "Example-123",
  • "companyEmail": "company@example.com",
  • "customData": { },
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z",
  • "reference": "Example-123",
  • "reporterFirstName": "John",
  • "reporterLastName": "Smith",
  • "approverFirstName": "John",
  • "approverLastName": "Smith",
  • "signeeType": "crewDetails",
  • "attachments": [
    ],
  • "approvalReleaseRequired": false,
  • "approvedById": "01610b42-5e89-4eb4-a17f-c20e7f7d2676"
}

Update release (without signature) by ID

Update a release, based on the ID. Only releases without a signature are updatable

path Parameters
id
required
string <uuid>

The id of the Release

Request Body schema: application/json
required
companyEmail
string
licenceNumber
string
firstName
string
lastName
string
reporterFirstName
string
reporterLastName
string
approvalNumber
string
companyName
string
reference
string
date
string <date>
signeeType
string (SigneeType)
Enum: "crewDetails" "engineerDetails" "crsDocument"
approverFirstName
string
approverLastName
string

Responses

Request samples

Content type
application/json
{
  • "companyEmail": "company@example.com",
  • "licenceNumber": "Example-123",
  • "firstName": "John",
  • "lastName": "Smith",
  • "reporterFirstName": "John",
  • "reporterLastName": "Smith",
  • "approvalNumber": "Example-123",
  • "companyName": "ExampleCompany",
  • "reference": "Example-123",
  • "date": "2022-07-07",
  • "signeeType": "crewDetails",
  • "approverFirstName": "John",
  • "approverLastName": "Smith"
}

Response samples

Content type
application/json
{
  • "id": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "aircraftId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "operatorId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "workpackId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "openDefectIds": [
    ],
  • "additionalItems": [
    ],
  • "mxItemIds": [
    ],
  • "date": "2022-07-07T15:37:00Z",
  • "companyName": "ExampleCompany",
  • "approvalNumber": "Example-123",
  • "firstName": "John",
  • "lastName": "Smith",
  • "licenceNumber": "Example-123",
  • "companyEmail": "company@example.com",
  • "customData": { },
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z",
  • "reference": "Example-123",
  • "reporterFirstName": "John",
  • "reporterLastName": "Smith",
  • "approverFirstName": "John",
  • "approverLastName": "Smith",
  • "signeeType": "crewDetails",
  • "attachments": [
    ],
  • "approvalReleaseRequired": false,
  • "approvedById": "01610b42-5e89-4eb4-a17f-c20e7f7d2676"
}

Add a release against workpack

Creates release against workpack with passed id

path Parameters
id
required
string <uuid>

The id of the Workpack

Request Body schema: application/json
required
companyEmail
string
licenceNumber
string
firstName
string
lastName
string
reporterFirstName
string
reporterLastName
string
approvalNumber
string
companyName
string
reference
string
date
string <date>
signeeType
string (SigneeType)
Enum: "crewDetails" "engineerDetails" "crsDocument"
approverFirstName
string
approverLastName
string

Responses

Request samples

Content type
application/json
{
  • "companyEmail": "company@example.com",
  • "licenceNumber": "Example-123",
  • "firstName": "John",
  • "lastName": "Smith",
  • "reporterFirstName": "John",
  • "reporterLastName": "Smith",
  • "approvalNumber": "Example-123",
  • "companyName": "ExampleCompany",
  • "reference": "Example-123",
  • "date": "2022-07-07",
  • "signeeType": "crewDetails",
  • "approverFirstName": "John",
  • "approverLastName": "Smith"
}

Response samples

Content type
application/json
{
  • "id": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "aircraftId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "operatorId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "workpackId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "openDefectIds": [
    ],
  • "additionalItems": [
    ],
  • "mxItemIds": [
    ],
  • "date": "2022-07-07T15:37:00Z",
  • "companyName": "ExampleCompany",
  • "approvalNumber": "Example-123",
  • "firstName": "John",
  • "lastName": "Smith",
  • "licenceNumber": "Example-123",
  • "companyEmail": "company@example.com",
  • "customData": { },
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z",
  • "reference": "Example-123",
  • "reporterFirstName": "John",
  • "reporterLastName": "Smith",
  • "approverFirstName": "John",
  • "approverLastName": "Smith",
  • "signeeType": "crewDetails",
  • "attachments": [
    ],
  • "approvalReleaseRequired": false,
  • "approvedById": "01610b42-5e89-4eb4-a17f-c20e7f7d2676"
}

ScheduledMxItems

Endpoints associated with ScheduledMxItems

Returns a paginated list of ScheduledMxItems scoped to the Aircraft with the passed ID

Lists ScheduledMxItems by Aircraft ID

path Parameters
id
required
string <uuid>

ID of the Aircraft that the ScheduledMxItems have been raised against

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

updatedAfter
string <date-time>
Example: updatedAfter=2022-02-14T11:08:00Z

Will only return records that have been updated at or after this datetime

hasAppliedTolerance
boolean
Example: hasAppliedTolerance=true

A boolean to determine whether ScheduledMxItems that have tolerance applied should be returned or not. When omitted all items will be returned regardless of whether they have tolerance applied.

mxArea
Array of strings
Default: "airframe&mxArea=apu&mxArea=engine&mxArea=prop"
Items Enum: "airframe" "apu" "engine" "prop"
Example: mxArea=airframe&mxArea=engine

An array of maintenance areas to filter the returned ScheduledMxItems by.

mxType
Array of strings
Default: "oop&mxType=llp&mxType=scheduled"
Items Enum: "oop" "llp" "scheduled"
Example: mxType=oop&mxType=llp

An array of maintenance types to filter the returned ScheduledMxItems by.

status
Array of strings
Items Enum: "open" "resolved" "overdue" "critical" "draft" "resolution_pending"
Example: status=draft&status=resolved

An array of statuses to filter the returned ScheduledMxItems by

startDueDate
string <date>
Example: startDueDate=2022-03-03

The dueDate (inclusive) from which to return ScheduledMxItems. Must be <= endDueDate.

endDueDate
string <date>
Example: endDueDate=2022-03-03

The dueDate (inclusive) up to which to return ScheduledMxItems. Must be >= startDueDate.

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Create a new ScheduledMxItem

Add a new ScheduledMxItem against an Aircraft

path Parameters
id
required
string <uuid>

ID of aircraft that the ScheduledMxItem should be created against

Request Body schema: application/json
required
aircraftId
string <uuid>
packageId
string <uuid>

The ScheduledMxItem representing the package that this is part of (if any)

draft
boolean
source
string
details
string
name
string
number
integer
dueDate
string <date-time>

Use this in preference to dueDateTime unless you expressly need to specify a time. Only one of dueDate and dueDateTime can be set

dueDateTime
string <date-time>

Only one of dueDate and dueDateTime can be set

estimatedDate
string <date-time>
dueFlightSeconds
integer
dueApuSeconds
integer
dueCycles
integer
dueLandings
integer
repeatFlightSeconds
integer
toleranceFlightSeconds
integer
visibleToleranceFlightSeconds
integer
thresholdFlightSeconds
integer
repeatApuSeconds
integer
toleranceApuSeconds
integer
visibleToleranceApuSeconds
integer
thresholdApuSeconds
integer
repeatDays
integer
toleranceDays
integer
visibleToleranceDays
integer
thresholdDays
integer
repeatMonths
integer
toleranceMonths
integer
visibleToleranceMonths
integer
thresholdMonths
integer
repeatCycles
integer
toleranceCycles
integer
thresholdCycles
integer
repeatRemarks
string
partNumber
string
partSerial
string
reference
string
ataChapter
integer
ataSection
integer
assembly
string
customData
object
operatorReference
string
placardProcedureCompleted
boolean
operationalProcedureCompleted
boolean
crewActionable
boolean
serviceabilityLimiting
boolean
normalisedFlightSecondsDue
integer
normalisedCyclesDue
integer
unitOfTime
string
Enum: "days" "months"
importedAt
string <date-time>
editedBy
string <uuid>
eropsPrevented
boolean
placardNumber
string
calendarDaysAmberLimit
integer

Only one of calendarDaysAmberLimit and calendarDaysSecondsLimit can be set

calendarDaysSecondsLimit
integer

Only one of calendarDaysAmberLimit and calendarDaysSecondsLimit can be set

Responses

Request samples

Content type
application/json
{
  • "aircraftId": "111a0029-6811-4c9f-8e04-4bafe2de6999",
  • "packageId": "f55a0029-6811-4c9f-8e04-4bafe2de6222",
  • "draft": true,
  • "source": "string",
  • "details": "string",
  • "name": "string",
  • "number": 1,
  • "dueDate": "2022-04-04",
  • "dueDateTime": "2022-04-02T17:08:00Z",
  • "estimatedDate": "2022-04-03",
  • "dueFlightSeconds": 1000,
  • "dueApuSeconds": 1000,
  • "dueCycles": 100,
  • "dueLandings": 100,
  • "repeatFlightSeconds": 1000,
  • "toleranceFlightSeconds": 100,
  • "visibleToleranceFlightSeconds": 100,
  • "thresholdFlightSeconds": 10,
  • "repeatApuSeconds": 100,
  • "toleranceApuSeconds": 10,
  • "visibleToleranceApuSeconds": 10,
  • "thresholdApuSeconds": 1,
  • "repeatDays": 50,
  • "toleranceDays": 5,
  • "visibleToleranceDays": 5,
  • "thresholdDays": 2,
  • "repeatMonths": 50,
  • "toleranceMonths": 5,
  • "visibleToleranceMonths": 5,
  • "thresholdMonths": 2,
  • "repeatCycles": 40,
  • "toleranceCycles": 4,
  • "thresholdCycles": 2,
  • "repeatRemarks": "doing it again",
  • "partNumber": "abc-123",
  • "partSerial": "qwerty123",
  • "reference": "tgdbetg",
  • "ataChapter": 59,
  • "ataSection": 5,
  • "assembly": "string",
  • "customData": { },
  • "operatorReference": "456xyz",
  • "placardProcedureCompleted": true,
  • "operationalProcedureCompleted": true,
  • "crewActionable": true,
  • "serviceabilityLimiting": true,
  • "normalisedFlightSecondsDue": 48000,
  • "normalisedCyclesDue": 50,
  • "unitOfTime": "days",
  • "importedAt": "2022-02-02T09:08:00Z",
  • "editedBy": "999e0029-6811-4c9f-8e04-4bafe2de6111",
  • "eropsPrevented": false,
  • "placardNumber": "abc123",
  • "calendarDaysAmberLimit": 10,
  • "calendarDaysSecondsLimit": 129600
}

Response samples

Content type
application/json
{
  • "id": "c11a0029-6811-4c9f-8e04-4bafe2de6999",
  • "aircraftId": "111a0029-6811-4c9f-8e04-4bafe2de6999",
  • "packageId": "f55a0029-6811-4c9f-8e04-4bafe2de6222",
  • "draft": true,
  • "source": "string",
  • "details": "string",
  • "name": "string",
  • "number": 1,
  • "dueDate": "2022-04-04",
  • "dueDateTime": "2022-04-02T17:08:00Z",
  • "estimatedDate": "2022-04-03",
  • "dueFlightSeconds": 1000,
  • "dueApuSeconds": 1000,
  • "dueCycles": 100,
  • "dueLandings": 100,
  • "repeatFlightSeconds": 1000,
  • "toleranceFlightSeconds": 100,
  • "visibleToleranceFlightSeconds": 100,
  • "thresholdFlightSeconds": 10,
  • "repeatApuSeconds": 100,
  • "toleranceApuSeconds": 10,
  • "visibleToleranceApuSeconds": 10,
  • "thresholdApuSeconds": 1,
  • "repeatDays": 50,
  • "toleranceDays": 5,
  • "visibleToleranceDays": 5,
  • "thresholdDays": 2,
  • "repeatMonths": 50,
  • "toleranceMonths": 5,
  • "visibleToleranceMonths": 5,
  • "thresholdMonths": 2,
  • "repeatCycles": 40,
  • "toleranceCycles": 4,
  • "thresholdCycles": 2,
  • "repeatRemarks": "doing it again",
  • "partNumber": "abc-123",
  • "partSerial": "qwerty123",
  • "reference": "tgdbetg",
  • "ataChapter": 59,
  • "ataSection": 5,
  • "assembly": "string",
  • "customData": { },
  • "operatorReference": "456xyz",
  • "placardProcedureCompleted": true,
  • "operationalProcedureCompleted": true,
  • "crewActionable": true,
  • "serviceabilityLimiting": true,
  • "normalisedFlightSecondsDue": 48000,
  • "normalisedCyclesDue": 50,
  • "unitOfTime": "days",
  • "importedAt": "2022-02-02T09:08:00Z",
  • "editedBy": "999e0029-6811-4c9f-8e04-4bafe2de6111",
  • "eropsPrevented": false,
  • "placardNumber": "abc123",
  • "calendarDaysAmberLimit": 10,
  • "calendarDaysSecondsLimit": 129600,
  • "editedDate": "2022-04-02T17:08:00Z",
  • "campSyncDate": "2022-04-02T17:08:00Z",
  • "thirdPartyReferences": {
    },
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z"
}

List all ScheduledMxItems meeting criteria

List all ScheduledMxItems meeting criteria

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

updatedAfter
string <date-time>
Example: updatedAfter=2022-02-14T11:08:00Z

Will only return records that have been updated at or after this datetime

hasAppliedTolerance
boolean
Example: hasAppliedTolerance=true

A boolean to determine whether ScheduledMxItems that have tolerance applied should be returned or not. When omitted all items will be returned regardless of whether they have tolerance applied.

mxArea
Array of strings
Default: "airframe&mxArea=apu&mxArea=engine&mxArea=prop"
Items Enum: "airframe" "apu" "engine" "prop"
Example: mxArea=airframe&mxArea=engine

An array of maintenance areas to filter the returned ScheduledMxItems by.

mxType
Array of strings
Default: "oop&mxType=llp&mxType=scheduled"
Items Enum: "oop" "llp" "scheduled"
Example: mxType=oop&mxType=llp

An array of maintenance types to filter the returned ScheduledMxItems by.

status
Array of strings
Items Enum: "open" "resolved" "overdue" "critical" "draft" "resolution_pending"
Example: status=draft&status=resolved

An array of statuses to filter the returned ScheduledMxItems by

startDueDate
string <date>
Example: startDueDate=2022-03-03

The dueDate (inclusive) from which to return ScheduledMxItems. Must be <= endDueDate.

endDueDate
string <date>
Example: endDueDate=2022-03-03

The dueDate (inclusive) up to which to return ScheduledMxItems. Must be >= startDueDate.

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Find ScheduledMxItem by ID

Get the details of a ScheduledMxItem by ID

path Parameters
id
required
string

ID of ScheduledMxItem being queried

Responses

Response samples

Content type
application/json
{
  • "id": "c11a0029-6811-4c9f-8e04-4bafe2de6999",
  • "aircraftId": "111a0029-6811-4c9f-8e04-4bafe2de6999",
  • "packageId": "f55a0029-6811-4c9f-8e04-4bafe2de6222",
  • "draft": true,
  • "source": "string",
  • "details": "string",
  • "name": "string",
  • "number": 1,
  • "dueDate": "2022-04-04",
  • "dueDateTime": "2022-04-02T17:08:00Z",
  • "estimatedDate": "2022-04-03",
  • "dueFlightSeconds": 1000,
  • "dueApuSeconds": 1000,
  • "dueCycles": 100,
  • "dueLandings": 100,
  • "repeatFlightSeconds": 1000,
  • "toleranceFlightSeconds": 100,
  • "visibleToleranceFlightSeconds": 100,
  • "thresholdFlightSeconds": 10,
  • "repeatApuSeconds": 100,
  • "toleranceApuSeconds": 10,
  • "visibleToleranceApuSeconds": 10,
  • "thresholdApuSeconds": 1,
  • "repeatDays": 50,
  • "toleranceDays": 5,
  • "visibleToleranceDays": 5,
  • "thresholdDays": 2,
  • "repeatMonths": 50,
  • "toleranceMonths": 5,
  • "visibleToleranceMonths": 5,
  • "thresholdMonths": 2,
  • "repeatCycles": 40,
  • "toleranceCycles": 4,
  • "thresholdCycles": 2,
  • "repeatRemarks": "doing it again",
  • "partNumber": "abc-123",
  • "partSerial": "qwerty123",
  • "reference": "tgdbetg",
  • "ataChapter": 59,
  • "ataSection": 5,
  • "assembly": "string",
  • "customData": { },
  • "operatorReference": "456xyz",
  • "placardProcedureCompleted": true,
  • "operationalProcedureCompleted": true,
  • "crewActionable": true,
  • "serviceabilityLimiting": true,
  • "normalisedFlightSecondsDue": 48000,
  • "normalisedCyclesDue": 50,
  • "unitOfTime": "days",
  • "importedAt": "2022-02-02T09:08:00Z",
  • "editedBy": "999e0029-6811-4c9f-8e04-4bafe2de6111",
  • "eropsPrevented": false,
  • "placardNumber": "abc123",
  • "calendarDaysAmberLimit": 10,
  • "calendarDaysSecondsLimit": 129600,
  • "editedDate": "2022-04-02T17:08:00Z",
  • "campSyncDate": "2022-04-02T17:08:00Z",
  • "thirdPartyReferences": {
    },
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z"
}

Update a ScheduledMxItem

Updates a ScheduledMxItem based on Id

Request Body schema: application/json
required
aircraftId
string <uuid>
packageId
string <uuid>

The ScheduledMxItem representing the package that this is part of (if any)

draft
boolean
source
string
details
string
name
string
number
integer
dueDate
string <date-time>

Use this in preference to dueDateTime unless you expressly need to specify a time. Only one of dueDate and dueDateTime can be set

dueDateTime
string <date-time>

Only one of dueDate and dueDateTime can be set

estimatedDate
string <date-time>
dueFlightSeconds
integer
dueApuSeconds
integer
dueCycles
integer
dueLandings
integer
repeatFlightSeconds
integer
toleranceFlightSeconds
integer
visibleToleranceFlightSeconds
integer
thresholdFlightSeconds
integer
repeatApuSeconds
integer
toleranceApuSeconds
integer
visibleToleranceApuSeconds
integer
thresholdApuSeconds
integer
repeatDays
integer
toleranceDays
integer
visibleToleranceDays
integer
thresholdDays
integer
repeatMonths
integer
toleranceMonths
integer
visibleToleranceMonths
integer
thresholdMonths
integer
repeatCycles
integer
toleranceCycles
integer
thresholdCycles
integer
repeatRemarks
string
partNumber
string
partSerial
string
reference
string
ataChapter
integer
ataSection
integer
assembly
string
customData
object
operatorReference
string
placardProcedureCompleted
boolean
operationalProcedureCompleted
boolean
crewActionable
boolean
serviceabilityLimiting
boolean
normalisedFlightSecondsDue
integer
normalisedCyclesDue
integer
unitOfTime
string
Enum: "days" "months"
importedAt
string <date-time>
editedBy
string <uuid>
eropsPrevented
boolean
placardNumber
string
calendarDaysAmberLimit
integer

Only one of calendarDaysAmberLimit and calendarDaysSecondsLimit can be set

calendarDaysSecondsLimit
integer

Only one of calendarDaysAmberLimit and calendarDaysSecondsLimit can be set

Responses

Request samples

Content type
application/json
{
  • "aircraftId": "111a0029-6811-4c9f-8e04-4bafe2de6999",
  • "packageId": "f55a0029-6811-4c9f-8e04-4bafe2de6222",
  • "draft": true,
  • "source": "string",
  • "details": "string",
  • "name": "string",
  • "number": 1,
  • "dueDate": "2022-04-04",
  • "dueDateTime": "2022-04-02T17:08:00Z",
  • "estimatedDate": "2022-04-03",
  • "dueFlightSeconds": 1000,
  • "dueApuSeconds": 1000,
  • "dueCycles": 100,
  • "dueLandings": 100,
  • "repeatFlightSeconds": 1000,
  • "toleranceFlightSeconds": 100,
  • "visibleToleranceFlightSeconds": 100,
  • "thresholdFlightSeconds": 10,
  • "repeatApuSeconds": 100,
  • "toleranceApuSeconds": 10,
  • "visibleToleranceApuSeconds": 10,
  • "thresholdApuSeconds": 1,
  • "repeatDays": 50,
  • "toleranceDays": 5,
  • "visibleToleranceDays": 5,
  • "thresholdDays": 2,
  • "repeatMonths": 50,
  • "toleranceMonths": 5,
  • "visibleToleranceMonths": 5,
  • "thresholdMonths": 2,
  • "repeatCycles": 40,
  • "toleranceCycles": 4,
  • "thresholdCycles": 2,
  • "repeatRemarks": "doing it again",
  • "partNumber": "abc-123",
  • "partSerial": "qwerty123",
  • "reference": "tgdbetg",
  • "ataChapter": 59,
  • "ataSection": 5,
  • "assembly": "string",
  • "customData": { },
  • "operatorReference": "456xyz",
  • "placardProcedureCompleted": true,
  • "operationalProcedureCompleted": true,
  • "crewActionable": true,
  • "serviceabilityLimiting": true,
  • "normalisedFlightSecondsDue": 48000,
  • "normalisedCyclesDue": 50,
  • "unitOfTime": "days",
  • "importedAt": "2022-02-02T09:08:00Z",
  • "editedBy": "999e0029-6811-4c9f-8e04-4bafe2de6111",
  • "eropsPrevented": false,
  • "placardNumber": "abc123",
  • "calendarDaysAmberLimit": 10,
  • "calendarDaysSecondsLimit": 129600
}

Response samples

Content type
application/json
{
  • "id": "c11a0029-6811-4c9f-8e04-4bafe2de6999",
  • "aircraftId": "111a0029-6811-4c9f-8e04-4bafe2de6999",
  • "packageId": "f55a0029-6811-4c9f-8e04-4bafe2de6222",
  • "draft": true,
  • "source": "string",
  • "details": "string",
  • "name": "string",
  • "number": 1,
  • "dueDate": "2022-04-04",
  • "dueDateTime": "2022-04-02T17:08:00Z",
  • "estimatedDate": "2022-04-03",
  • "dueFlightSeconds": 1000,
  • "dueApuSeconds": 1000,
  • "dueCycles": 100,
  • "dueLandings": 100,
  • "repeatFlightSeconds": 1000,
  • "toleranceFlightSeconds": 100,
  • "visibleToleranceFlightSeconds": 100,
  • "thresholdFlightSeconds": 10,
  • "repeatApuSeconds": 100,
  • "toleranceApuSeconds": 10,
  • "visibleToleranceApuSeconds": 10,
  • "thresholdApuSeconds": 1,
  • "repeatDays": 50,
  • "toleranceDays": 5,
  • "visibleToleranceDays": 5,
  • "thresholdDays": 2,
  • "repeatMonths": 50,
  • "toleranceMonths": 5,
  • "visibleToleranceMonths": 5,
  • "thresholdMonths": 2,
  • "repeatCycles": 40,
  • "toleranceCycles": 4,
  • "thresholdCycles": 2,
  • "repeatRemarks": "doing it again",
  • "partNumber": "abc-123",
  • "partSerial": "qwerty123",
  • "reference": "tgdbetg",
  • "ataChapter": 59,
  • "ataSection": 5,
  • "assembly": "string",
  • "customData": { },
  • "operatorReference": "456xyz",
  • "placardProcedureCompleted": true,
  • "operationalProcedureCompleted": true,
  • "crewActionable": true,
  • "serviceabilityLimiting": true,
  • "normalisedFlightSecondsDue": 48000,
  • "normalisedCyclesDue": 50,
  • "unitOfTime": "days",
  • "importedAt": "2022-02-02T09:08:00Z",
  • "editedBy": "999e0029-6811-4c9f-8e04-4bafe2de6111",
  • "eropsPrevented": false,
  • "placardNumber": "abc123",
  • "calendarDaysAmberLimit": 10,
  • "calendarDaysSecondsLimit": 129600,
  • "editedDate": "2022-04-02T17:08:00Z",
  • "campSyncDate": "2022-04-02T17:08:00Z",
  • "thirdPartyReferences": {
    },
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z"
}

Delete a ScheduledMxItem

Delete a ScheduledMxItem based on Id

path Parameters
id
required
string

ID of ScheduledMxItem being deleted

Responses

Response samples

Content type
application/problem+json
Example
{}

Sectors

Also known as flights - a journey an aircraft makes from one airport to another

List Defects for a Sector

Returns all Defects that belong to the Sector with the passed ID, ordered by dueDate ascending

path Parameters
id
required
string <uuid>

The id of the Sector to fetch all Defects for

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

defectTypes[]
Array of any
Default: "CAS&defectTypes[]=CDL&defectTypes[]=MEL&defectTypes[]=NEF&defectTypes[]=Other"
Items Enum: "CAS" "CDL" "MEL" "NEF" "Other"
Example: defectTypes[]=CAS&defectTypes[]=MEL

An array of defect types to filter the returned Defects by.

rectificationCategories[]
Array of any
Default: "A&rectificationCategories[]=ADVISORYONLY&rectificationCategories[]=B&rectificationCategories[]=C&rectificationCategories[]=D&rectificationCategories[]=NONDEFERRED"
Items Enum: "A" "ADVISORYONLY" "B" "C" "D" "NONDEFERRED"
Example: rectificationCategories[]=B&rectificationCategories[]=C

An array of rectification categories to filter the returned Defects by.

statuses[]
Array of any
Items Enum: "open" "resolved" "overdue" "deferral_pending" "resolution_pending"
Example: statuses[]=overdue&statuses[]=resolved

An array of statuses to filter the returned Defects by.

updatedAfter
string <date-time>
Example: updatedAfter=2022-02-14T11:08:00Z

Will only return records that have been updated at or after this datetime

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Get all FluidUplifts for a Sector

Returns all FluidUplifts that belong to the Sector with the passed ID

path Parameters
id
required
string <uuid>

The id of the Sector to fetch all FluidUplifts for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the fuel summary for a sector

Returns the fuel summary for the sector with the passed ID. This fuel summary returns values aggregated from underlying fuel records.

path Parameters
id
required
string <uuid>

The id of the Sector to fetch the fuel summary for

Responses

Response samples

Content type
application/json
{
  • "preUpliftFuel": 1000,
  • "postUpliftFuel": 1100,
  • "usedFuel": 600,
  • "remainingFuel": 500,
  • "departureFuelAdjustment": 30
}

Get all MxChecks for a Sector

Returns all MxChecks that belong to the Sector with the passed ID

path Parameters
id
required
string <uuid>

The id of the Sector to fetch all MxChecks for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all Sectors for a Trip

Returns all Sectors that belong to the Trip with the passed ID

path Parameters
id
required
string

ID of trip to use

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all Sectors for a Trip

Returns all Sectors that belong to the Trip with the passed ID (with corrected pilot fields)

path Parameters
id
required
string

ID of trip to use

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a new sector

Creates a sector

Request Body schema: application/json
required
tripId
string <uuid>
departureAirportId
integer <int32>
arrivalAirportId
integer <int32>
actualArrivalAirportId
integer <int32>
pilotInCommandId
string <uuid>
secondInCommandId
string <uuid>
pilotPerformingTakeoffId
string <uuid>
pilotPerformingLandingId
string <uuid>
userId
string <uuid>
apuSeconds
integer <int32>
apuReading
integer <int32>
apuCyclesReading
integer <int32>
hobbsDeparture
number <double>
hobbsArrival
number <double>
offblocksTime
string <date-time>
takeoffTime
string <date-time>
landingTime
string <date-time>
onblocksTime
string <date-time>
landingsCount
integer
preflightCustomData
object

An object containing custom preflight data for the sector

postflightCustomData
object

An object containing custom postflight data for the sector

Array of objects (FluidUpliftBody)
Array of objects (FuelUpliftBody)
Array of objects (DeiceEventBody)

Responses

Request samples

Content type
application/json
{
  • "tripId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "departureAirportId": 1,
  • "arrivalAirportId": 1,
  • "actualArrivalAirportId": 1,
  • "pilotInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "secondInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotPerformingTakeoffId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotPerformingLandingId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "userId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "apuSeconds": 1,
  • "apuReading": 1,
  • "apuCyclesReading": 1,
  • "hobbsDeparture": 1.5,
  • "hobbsArrival": 2.5,
  • "offblocksTime": "2022-07-07T13:37:00Z",
  • "takeoffTime": "2022-07-07T14:37:00Z",
  • "landingTime": "2022-07-07T15:37:00Z",
  • "onblocksTime": "2022-07-07T16:37:00Z",
  • "landingsCount": 1,
  • "preflightCustomData": {
    },
  • "postflightCustomData": {
    },
  • "fluidUplifts": [
    ],
  • "fuelUplifts": [
    ],
  • "deiceEvents": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "tripId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "departureAirportId": 1,
  • "arrivalAirportId": 2,
  • "actualArrivalAirportId": 3,
  • "pilotInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "secondInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotPerformingTakeoffId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotPerformingLandingId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "userId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "apuSeconds": 1,
  • "apuReading": 1,
  • "apuCyclesReading": 1,
  • "hobbsDeparture": 1.5,
  • "hobbsArrival": 2.5,
  • "offblocksTime": "2022-07-07T13:37:00Z",
  • "takeoffTime": "2022-07-07T14:37:00Z",
  • "landingTime": "2022-07-07T15:37:00Z",
  • "onblocksTime": "2022-07-07T16:37:00Z",
  • "landingsCount": 1,
  • "takeoffsCount": 1,
  • "status": "partial",
  • "flightType": "training",
  • "remarks": "hi",
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z",
  • "date": "2022-01-02T07:08:00Z",
  • "source": "techlogApp",
  • "preflightCustomData": {
    },
  • "postflightCustomData": {
    },
  • "cycles": {
    },
  • "passengersMale": 1,
  • "passengersFemale": 1,
  • "passengersChildren": 1,
  • "passengersInfants": 1,
  • "baggageWeight": 1,
  • "gpuStart": "00:00:00",
  • "gpuEnd": "00:00:00",
  • "gpuSeconds": 1,
  • "maxFlightLevel": 1,
  • "pressurisedCycle": true,
  • "preflightMxCheckIds": [
    ],
  • "abandonmentReason": "technicalFailure",
  • "attachments": [
    ],
  • "fratScore": 50,
  • "plannedFuelBurn": 200,
  • "actualFuelBurn": 200,
  • "fuelBurnJustification": "Increased taxi length"
}

Finds all sectors

Returns all sectors from the system that the user has access to

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

aircraftIds[]
Array of strings <uuid> [ items <uuid > ]
Example: aircraftIds[]=41f10b92-0e8a-4eb4-a17f-c20e7f124999&aircraftIds[]=fdb77302-68a9-4ce1-a2d7-4b42b3b36dcd

An array of Aircraft IDs to limit the returned records by

tripIds[]
Array of strings <uuid> [ items <uuid > ]
Example: tripIds[]=41f10b92-0e8a-4eb4-a17f-c20e7f124999&tripIds[]=fdb77302-68a9-4ce1-a2d7-4b42b3b36dcd

An array of Trip IDs to limit the returned Sectors by

startDate
string <date>
Example: startDate=2022-03-03

The date (inclusive) from which to return Sectors. Must be <= endDate.

endDate
string <date>
Example: endDate=2022-03-03

The date (inclusive) up to which to return Sectors. Must be >= startDate.

airportIcaoCodes
Array of strings
Example: airportIcaoCodes=KORD&airportIcaoCodes=EGLL

ICAO airport code(s) to filter by. The returned sectors will be those where that airport(s) is/are the point of departure, intended arrival or actual arrival

airportIds[]
Array of integers
Example: airportIds[]=1&airportIds[]=2

Trustflight airport ID(s) to filter by. The returned sectors will be those where the airport(s) is/are the point of departure, intended arrival or actual arrival

userIds[]
Array of strings <uuid> [ items <uuid > ]
Example: userIds[]=41f10b92-0e8a-4eb4-a17f-c20e7f124999&userIds[]=11f10b92-0e8a-4eb4-a17f-c20e7f124888

UserId(s) to filter by. The returned sectors will be those where this user(s) is/are designated as the pilot in command or second in command

updatedAfter
string <date-time>
Example: updatedAfter=2022-02-14T11:08:00Z

Will only return sectors that have been updated at or after this datetime

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Add a new sector

Creates a sector (with corrected pilot fields)

Request Body schema: application/json
required
tripId
string <uuid>
departureAirportId
integer <int32>
arrivalAirportId
integer <int32>
actualArrivalAirportId
integer <int32>
pilotInCommandId
string <uuid>
secondInCommandId
string <uuid>
pilotPerformingTakeoffId
string <uuid>
pilotPerformingLandingId
string <uuid>
userId
string <uuid>
apuSeconds
integer <int32>
apuReading
integer <int32>
apuCyclesReading
integer <int32>
hobbsDeparture
number <double>
hobbsArrival
number <double>
offblocksTime
string <date-time>
takeoffTime
string <date-time>
landingTime
string <date-time>
onblocksTime
string <date-time>
landingsCount
integer
preflightCustomData
object

An object containing custom preflight data for the sector

postflightCustomData
object

An object containing custom postflight data for the sector

pilotFlyingId
string <uuid>
pilotMonitoringId
string <uuid>
Array of objects (FluidUpliftBody)
Array of objects (FuelUpliftBody)
Array of objects (DeiceEventBody)

Responses

Request samples

Content type
application/json
{
  • "tripId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "departureAirportId": 1,
  • "arrivalAirportId": 1,
  • "actualArrivalAirportId": 1,
  • "pilotInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "secondInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotPerformingTakeoffId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotPerformingLandingId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "userId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "apuSeconds": 1,
  • "apuReading": 1,
  • "apuCyclesReading": 1,
  • "hobbsDeparture": 1.5,
  • "hobbsArrival": 2.5,
  • "offblocksTime": "2022-07-07T13:37:00Z",
  • "takeoffTime": "2022-07-07T14:37:00Z",
  • "landingTime": "2022-07-07T15:37:00Z",
  • "onblocksTime": "2022-07-07T16:37:00Z",
  • "landingsCount": 1,
  • "preflightCustomData": {
    },
  • "postflightCustomData": {
    },
  • "pilotFlyingId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotMonitoringId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "fluidUplifts": [
    ],
  • "fuelUplifts": [
    ],
  • "deiceEvents": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "tripId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "departureAirportId": 1,
  • "arrivalAirportId": 2,
  • "actualArrivalAirportId": 3,
  • "pilotInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "secondInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotPerformingTakeoffId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotPerformingLandingId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "userId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "apuSeconds": 1,
  • "apuReading": 1,
  • "apuCyclesReading": 1,
  • "hobbsDeparture": 1.5,
  • "hobbsArrival": 2.5,
  • "offblocksTime": "2022-07-07T13:37:00Z",
  • "takeoffTime": "2022-07-07T14:37:00Z",
  • "landingTime": "2022-07-07T15:37:00Z",
  • "onblocksTime": "2022-07-07T16:37:00Z",
  • "landingsCount": 1,
  • "takeoffsCount": 1,
  • "status": "partial",
  • "flightType": "training",
  • "remarks": "hi",
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z",
  • "date": "2022-01-02T07:08:00Z",
  • "source": "techlogApp",
  • "preflightCustomData": {
    },
  • "postflightCustomData": {
    },
  • "cycles": {
    },
  • "passengersMale": 1,
  • "passengersFemale": 1,
  • "passengersChildren": 1,
  • "passengersInfants": 1,
  • "baggageWeight": 1,
  • "gpuStart": "00:00:00",
  • "gpuEnd": "00:00:00",
  • "gpuSeconds": 1,
  • "maxFlightLevel": 1,
  • "pressurisedCycle": true,
  • "preflightMxCheckIds": [
    ],
  • "abandonmentReason": "technicalFailure",
  • "attachments": [
    ],
  • "fratScore": 50,
  • "plannedFuelBurn": 200,
  • "actualFuelBurn": 200,
  • "fuelBurnJustification": "Increased taxi length",
  • "pilotFlyingId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotMonitoringId": "01610b42-5e89-4eb4-a17f-c20e7f772676"
}

Finds all sectors

Returns all sectors from the system that the user has access to (with corrected pilot fields)

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

aircraftIds[]
Array of strings <uuid> [ items <uuid > ]
Example: aircraftIds[]=41f10b92-0e8a-4eb4-a17f-c20e7f124999&aircraftIds[]=fdb77302-68a9-4ce1-a2d7-4b42b3b36dcd

An array of Aircraft IDs to limit the returned records by

tripIds[]
Array of strings <uuid> [ items <uuid > ]
Example: tripIds[]=41f10b92-0e8a-4eb4-a17f-c20e7f124999&tripIds[]=fdb77302-68a9-4ce1-a2d7-4b42b3b36dcd

An array of Trip IDs to limit the returned Sectors by

startDate
string <date>
Example: startDate=2022-03-03

The date (inclusive) from which to return Sectors. Must be <= endDate.

endDate
string <date>
Example: endDate=2022-03-03

The date (inclusive) up to which to return Sectors. Must be >= startDate.

airportIcaoCodes
Array of strings
Example: airportIcaoCodes=KORD&airportIcaoCodes=EGLL

ICAO airport code(s) to filter by. The returned sectors will be those where that airport(s) is/are the point of departure, intended arrival or actual arrival

airportIds[]
Array of integers
Example: airportIds[]=1&airportIds[]=2

Trustflight airport ID(s) to filter by. The returned sectors will be those where the airport(s) is/are the point of departure, intended arrival or actual arrival

userIds[]
Array of strings <uuid> [ items <uuid > ]
Example: userIds[]=41f10b92-0e8a-4eb4-a17f-c20e7f124999&userIds[]=11f10b92-0e8a-4eb4-a17f-c20e7f124888

UserId(s) to filter by. The returned sectors will be those where this user(s) is/are designated as the pilot in command or second in command

updatedAfter
string <date-time>
Example: updatedAfter=2022-02-14T11:08:00Z

Will only return sectors that have been updated at or after this datetime

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Delete a sector by ID

Delete a sector by ID

path Parameters
id
required
string <uuid>

ID of sector to use

Responses

Response samples

Content type
application/problem+json
Example
{}

Find sector by ID

Returns an sector based on ID

path Parameters
id
required
string

ID of sector to use

Responses

Response samples

Content type
application/json
{
  • "id": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "tripId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "departureAirportId": 1,
  • "arrivalAirportId": 2,
  • "actualArrivalAirportId": 3,
  • "pilotInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "secondInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotPerformingTakeoffId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotPerformingLandingId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "userId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "apuSeconds": 1,
  • "apuReading": 1,
  • "apuCyclesReading": 1,
  • "hobbsDeparture": 1.5,
  • "hobbsArrival": 2.5,
  • "offblocksTime": "2022-07-07T13:37:00Z",
  • "takeoffTime": "2022-07-07T14:37:00Z",
  • "landingTime": "2022-07-07T15:37:00Z",
  • "onblocksTime": "2022-07-07T16:37:00Z",
  • "landingsCount": 1,
  • "takeoffsCount": 1,
  • "status": "partial",
  • "flightType": "training",
  • "remarks": "hi",
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z",
  • "date": "2022-01-02T07:08:00Z",
  • "source": "techlogApp",
  • "preflightCustomData": {
    },
  • "postflightCustomData": {
    },
  • "cycles": {
    },
  • "passengersMale": 1,
  • "passengersFemale": 1,
  • "passengersChildren": 1,
  • "passengersInfants": 1,
  • "baggageWeight": 1,
  • "gpuStart": "00:00:00",
  • "gpuEnd": "00:00:00",
  • "gpuSeconds": 1,
  • "maxFlightLevel": 1,
  • "pressurisedCycle": true,
  • "preflightMxCheckIds": [
    ],
  • "abandonmentReason": "technicalFailure",
  • "attachments": [
    ],
  • "fratScore": 50,
  • "plannedFuelBurn": 200,
  • "actualFuelBurn": 200,
  • "fuelBurnJustification": "Increased taxi length"
}

Update sector by ID

Updates a sector based on ID

Note: The preflightCustomData & postflightCustomData objects will overwrite what is currently stored. It will not merge their contents.

path Parameters
id
required
string

ID of sector to use

Request Body schema: application/json
required
departureAirportId
integer <int32>
arrivalAirportId
integer <int32>
actualArrivalAirportId
integer <int32>
pilotInCommandId
string <uuid>
secondInCommandId
string <uuid>
pilotPerformingTakeoffId
string <uuid>
pilotPerformingLandingId
string <uuid>
userId
string <uuid>
apuSeconds
integer <int32>
apuReading
integer <int32>
apuCyclesReading
integer <int32>
hobbsDeparture
number <double>
hobbsArrival
number <double>
offblocksTime
string <date-time>
takeoffTime
string <date-time>
landingTime
string <date-time>
onblocksTime
string <date-time>
landingsCount
integer
preflightCustomData
object

An object containing custom preflight data for the sector

postflightCustomData
object

An object containing custom postflight data for the sector

Responses

Request samples

Content type
application/json
{
  • "departureAirportId": 1,
  • "arrivalAirportId": 1,
  • "actualArrivalAirportId": 1,
  • "pilotInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "secondInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotPerformingTakeoffId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotPerformingLandingId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "userId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "apuSeconds": 1,
  • "apuReading": 1,
  • "apuCyclesReading": 1,
  • "hobbsDeparture": 1.5,
  • "hobbsArrival": 2.5,
  • "offblocksTime": "2022-07-07T13:37:00Z",
  • "takeoffTime": "2022-07-07T14:37:00Z",
  • "landingTime": "2022-07-07T15:37:00Z",
  • "onblocksTime": "2022-07-07T16:37:00Z",
  • "landingsCount": 1,
  • "preflightCustomData": {
    },
  • "postflightCustomData": {
    }
}

Response samples

Content type
application/json
{
  • "id": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "tripId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "departureAirportId": 1,
  • "arrivalAirportId": 2,
  • "actualArrivalAirportId": 3,
  • "pilotInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "secondInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotPerformingTakeoffId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotPerformingLandingId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "userId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "apuSeconds": 1,
  • "apuReading": 1,
  • "apuCyclesReading": 1,
  • "hobbsDeparture": 1.5,
  • "hobbsArrival": 2.5,
  • "offblocksTime": "2022-07-07T13:37:00Z",
  • "takeoffTime": "2022-07-07T14:37:00Z",
  • "landingTime": "2022-07-07T15:37:00Z",
  • "onblocksTime": "2022-07-07T16:37:00Z",
  • "landingsCount": 1,
  • "takeoffsCount": 1,
  • "status": "partial",
  • "flightType": "training",
  • "remarks": "hi",
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z",
  • "date": "2022-01-02T07:08:00Z",
  • "source": "techlogApp",
  • "preflightCustomData": {
    },
  • "postflightCustomData": {
    },
  • "cycles": {
    },
  • "passengersMale": 1,
  • "passengersFemale": 1,
  • "passengersChildren": 1,
  • "passengersInfants": 1,
  • "baggageWeight": 1,
  • "gpuStart": "00:00:00",
  • "gpuEnd": "00:00:00",
  • "gpuSeconds": 1,
  • "maxFlightLevel": 1,
  • "pressurisedCycle": true,
  • "preflightMxCheckIds": [
    ],
  • "abandonmentReason": "technicalFailure",
  • "attachments": [
    ],
  • "fratScore": 50,
  • "plannedFuelBurn": 200,
  • "actualFuelBurn": 200,
  • "fuelBurnJustification": "Increased taxi length"
}

Get a single sector by ID

Returns a specific sector based on ID (with corrected pilot fields)

path Parameters
id
required
string <uuid>

ID of sector to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "tripId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "departureAirportId": 1,
  • "arrivalAirportId": 2,
  • "actualArrivalAirportId": 3,
  • "pilotInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "secondInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotPerformingTakeoffId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotPerformingLandingId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "userId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "apuSeconds": 1,
  • "apuReading": 1,
  • "apuCyclesReading": 1,
  • "hobbsDeparture": 1.5,
  • "hobbsArrival": 2.5,
  • "offblocksTime": "2022-07-07T13:37:00Z",
  • "takeoffTime": "2022-07-07T14:37:00Z",
  • "landingTime": "2022-07-07T15:37:00Z",
  • "onblocksTime": "2022-07-07T16:37:00Z",
  • "landingsCount": 1,
  • "takeoffsCount": 1,
  • "status": "partial",
  • "flightType": "training",
  • "remarks": "hi",
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z",
  • "date": "2022-01-02T07:08:00Z",
  • "source": "techlogApp",
  • "preflightCustomData": {
    },
  • "postflightCustomData": {
    },
  • "cycles": {
    },
  • "passengersMale": 1,
  • "passengersFemale": 1,
  • "passengersChildren": 1,
  • "passengersInfants": 1,
  • "baggageWeight": 1,
  • "gpuStart": "00:00:00",
  • "gpuEnd": "00:00:00",
  • "gpuSeconds": 1,
  • "maxFlightLevel": 1,
  • "pressurisedCycle": true,
  • "preflightMxCheckIds": [
    ],
  • "abandonmentReason": "technicalFailure",
  • "attachments": [
    ],
  • "fratScore": 50,
  • "plannedFuelBurn": 200,
  • "actualFuelBurn": 200,
  • "fuelBurnJustification": "Increased taxi length",
  • "pilotFlyingId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotMonitoringId": "01610b42-5e89-4eb4-a17f-c20e7f772676"
}

Update sector by ID

Updates a sector based on ID (with corrected pilot fields)

Note: The preflightCustomData & postflightCustomData objects will overwrite what is currently stored. It will not merge their contents.

path Parameters
id
required
string

ID of sector to use

Request Body schema: application/json
required
departureAirportId
integer <int32>
arrivalAirportId
integer <int32>
actualArrivalAirportId
integer <int32>
pilotInCommandId
string <uuid>
secondInCommandId
string <uuid>
pilotPerformingTakeoffId
string <uuid>
pilotPerformingLandingId
string <uuid>
userId
string <uuid>
apuSeconds
integer <int32>
apuReading
integer <int32>
apuCyclesReading
integer <int32>
hobbsDeparture
number <double>
hobbsArrival
number <double>
offblocksTime
string <date-time>
takeoffTime
string <date-time>
landingTime
string <date-time>
onblocksTime
string <date-time>
landingsCount
integer
preflightCustomData
object

An object containing custom preflight data for the sector

postflightCustomData
object

An object containing custom postflight data for the sector

pilotFlyingId
string <uuid>
pilotMonitoringId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "departureAirportId": 1,
  • "arrivalAirportId": 1,
  • "actualArrivalAirportId": 1,
  • "pilotInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "secondInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotPerformingTakeoffId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotPerformingLandingId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "userId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "apuSeconds": 1,
  • "apuReading": 1,
  • "apuCyclesReading": 1,
  • "hobbsDeparture": 1.5,
  • "hobbsArrival": 2.5,
  • "offblocksTime": "2022-07-07T13:37:00Z",
  • "takeoffTime": "2022-07-07T14:37:00Z",
  • "landingTime": "2022-07-07T15:37:00Z",
  • "onblocksTime": "2022-07-07T16:37:00Z",
  • "landingsCount": 1,
  • "preflightCustomData": {
    },
  • "postflightCustomData": {
    },
  • "pilotFlyingId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotMonitoringId": "01610b42-5e89-4eb4-a17f-c20e7f772676"
}

Response samples

Content type
application/json
{
  • "id": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "tripId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "departureAirportId": 1,
  • "arrivalAirportId": 2,
  • "actualArrivalAirportId": 3,
  • "pilotInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "secondInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotPerformingTakeoffId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotPerformingLandingId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "userId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "apuSeconds": 1,
  • "apuReading": 1,
  • "apuCyclesReading": 1,
  • "hobbsDeparture": 1.5,
  • "hobbsArrival": 2.5,
  • "offblocksTime": "2022-07-07T13:37:00Z",
  • "takeoffTime": "2022-07-07T14:37:00Z",
  • "landingTime": "2022-07-07T15:37:00Z",
  • "onblocksTime": "2022-07-07T16:37:00Z",
  • "landingsCount": 1,
  • "takeoffsCount": 1,
  • "status": "partial",
  • "flightType": "training",
  • "remarks": "hi",
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z",
  • "date": "2022-01-02T07:08:00Z",
  • "source": "techlogApp",
  • "preflightCustomData": {
    },
  • "postflightCustomData": {
    },
  • "cycles": {
    },
  • "passengersMale": 1,
  • "passengersFemale": 1,
  • "passengersChildren": 1,
  • "passengersInfants": 1,
  • "baggageWeight": 1,
  • "gpuStart": "00:00:00",
  • "gpuEnd": "00:00:00",
  • "gpuSeconds": 1,
  • "maxFlightLevel": 1,
  • "pressurisedCycle": true,
  • "preflightMxCheckIds": [
    ],
  • "abandonmentReason": "technicalFailure",
  • "attachments": [
    ],
  • "fratScore": 50,
  • "plannedFuelBurn": 200,
  • "actualFuelBurn": 200,
  • "fuelBurnJustification": "Increased taxi length",
  • "pilotFlyingId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotMonitoringId": "01610b42-5e89-4eb4-a17f-c20e7f772676"
}

Find deice events by sector ID

Returns deice events for a given sector ID

path Parameters
id
required
string <uuid>
Example: 41f10b92-0e8a-4eb4-a17f-c20e7f124555

ID of sector to use

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Trips

Trips last for one day and may contain multiple sectors. Sectors must be assigned to a trip

Find trips/trip updates by aircraft ID

Returns trips and/or trip updates for a given aircraft ID

path Parameters
id
required
string <uuid>

ID of aircraft to use

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

includeIncomplete
boolean
Default: true
Example: includeIncomplete=false

Whether or not to include incomplete Trips in the response

includeTrips
boolean
Default: true
Example: includeTrips=false

Whether or not to include Trips in the response

includeTripUpdates
boolean
Default: true
Example: includeTripUpdates=false

Whether or not to include TripUpdates in the response

startDate
string <date>
Example: startDate=2022-03-03

The date (inclusive) from which to return the records. Must be <= endDate.

endDate
string <date>
Example: endDate=2022-03-03

The date (inclusive) from which to return the records. Must be >= startDate.

tripIds
Array of strings <uuid> [ items <uuid > ]
Example: tripIds=41f10b92-0e8a-4eb4-a17f-c20e7f124999&tripIds=fdb77302-68a9-4ce1-a2d7-4b42b3b36dcd

An array of Trip IDs to limit the returned Trips by

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Add a new trip

Creates a trip

Request Body schema: application/json
required
pilotInCommandId
string <uuid>
secondInCommandId
string <uuid>
date
string <date>
number
integer <int32>
srpNumber
integer <int32>
callsign
string
tripCategory
string
Enum: "private" "commercial" "scheduled" "maintenance" "training"
customData
object

An object containing custom data for the trip

thirdPartyReferences
object

References provided to the Trip by third party integrations. If this field is populated, the sent object will entirely replace what exists on TechLog's system

Responses

Request samples

Content type
application/json
{
  • "pilotInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "secondInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "date": "2022-07-07",
  • "number": 1,
  • "srpNumber": 1,
  • "callsign": "1-TEST",
  • "tripCategory": "private",
  • "customData": {
    },
  • "thirdPartyReferences": {
    }
}

Response samples

Content type
application/json
{
  • "id": "c11a0129-6811-4c9f-8004-4baf12de6999",
  • "aircraftId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "secondInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "date": "2022-07-07",
  • "number": 1,
  • "srpNumber": 1,
  • "callsign": "1-TEST",
  • "tripCategory": "private",
  • "customData": {
    },
  • "thirdPartyReferences": {
    },
  • "attachments": [
    ],
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z",
  • "isComplete": true,
  • "justificationDescription": "test",
  • "abandonmentReason": "technicalFailure"
}

Finds all trips

Returns all trips from the system that the user has access to

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Delete a trip by ID

Delete a trip by ID

path Parameters
id
required
string <uuid>

ID of trip to delete

Responses

Response samples

Content type
application/problem+json
Example
{}

Find trip by ID

Returns a trip based on ID

path Parameters
id
required
string

ID of trip to use

Responses

Response samples

Content type
application/json
{
  • "id": "c11a0129-6811-4c9f-8004-4baf12de6999",
  • "aircraftId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "secondInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "date": "2022-07-07",
  • "number": 1,
  • "srpNumber": 1,
  • "callsign": "1-TEST",
  • "tripCategory": "private",
  • "customData": {
    },
  • "thirdPartyReferences": {
    },
  • "attachments": [
    ],
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z",
  • "isComplete": true,
  • "justificationDescription": "test",
  • "abandonmentReason": "technicalFailure"
}

Update a trip by ID

Update a trip by ID.

Note: The customData object will overwrite what is currently stored. It will not merge their contents.

Request Body schema: application/json
required
pilotInCommandId
string <uuid>
secondInCommandId
string <uuid>
date
string <date>
number
integer <int32>
srpNumber
integer <int32>
callsign
string
tripCategory
string
Enum: "private" "commercial" "scheduled" "maintenance" "training"
customData
object

An object containing custom data for the trip

thirdPartyReferences
object

References provided to the Trip by third party integrations. If this field is populated, the sent object will entirely replace what exists on TechLog's system

Responses

Request samples

Content type
application/json
{
  • "pilotInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "secondInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "date": "2022-07-07",
  • "number": 1,
  • "srpNumber": 1,
  • "callsign": "1-TEST",
  • "tripCategory": "private",
  • "customData": {
    },
  • "thirdPartyReferences": {
    }
}

Response samples

Content type
application/json
{
  • "id": "c11a0129-6811-4c9f-8004-4baf12de6999",
  • "aircraftId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "secondInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "date": "2022-07-07",
  • "number": 1,
  • "srpNumber": 1,
  • "callsign": "1-TEST",
  • "tripCategory": "private",
  • "customData": {
    },
  • "thirdPartyReferences": {
    },
  • "attachments": [
    ],
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z",
  • "isComplete": true,
  • "justificationDescription": "test",
  • "abandonmentReason": "technicalFailure"
}

Fetch the sector record page PDF for a trip/trip update

Returns a binary representation of the trip/trip update's sector record page list in PDF format

path Parameters
id
required
string <uuid>

ID of trip/trip update to use

Responses

Response samples

Content type
application/problem+json
Example
{}

Fetch the journey log PDF for a trip

Returns a binary representation of the trip's journey log list in PDF format

path Parameters
id
required
string <uuid>

ID of trip to use

Responses

Response samples

Content type
application/problem+json
Example
{}

List all AdditionalCrew on a trip

List all AdditionalCrew on a trip

path Parameters
id
required
string

ID of trip to use

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add an AdditionalCrew to a trip

Add an AdditionalCrew to a trip

path Parameters
id
required
string

ID of trip to use

Request Body schema: application/json
required
personId
required
string <uuid>
personRoleId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "personId": "71610b42-5e89-4eb4-a17f-c20e7f772676",
  • "personRoleId": "81610b42-5e89-4eb4-a17f-c20e7f772676"
}

Response samples

Content type
application/json
{
  • "id": "61610b42-5e89-4eb4-a17f-c20e7f772676",
  • "personId": "71610b42-5e89-4eb4-a17f-c20e7f772676",
  • "personRoleId": "81610b42-5e89-4eb4-a17f-c20e7f772676",
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z"
}

Get all Sectors for a Trip

Returns all Sectors that belong to the Trip with the passed ID

path Parameters
id
required
string

ID of trip to use

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all Sectors for a Trip

Returns all Sectors that belong to the Trip with the passed ID (with corrected pilot fields)

path Parameters
id
required
string

ID of trip to use

Responses

Response samples

Content type
application/json
[
  • {
    }
]

TripUpdates

Trip Updates allow recording aircraft state changes in the form of additional hours or cycles, or overriding the totals carried forward if, for example, part changes have occurred

Find trips/trip updates by aircraft ID

Returns trips and/or trip updates for a given aircraft ID

path Parameters
id
required
string <uuid>

ID of aircraft to use

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

includeIncomplete
boolean
Default: true
Example: includeIncomplete=false

Whether or not to include incomplete Trips in the response

includeTrips
boolean
Default: true
Example: includeTrips=false

Whether or not to include Trips in the response

includeTripUpdates
boolean
Default: true
Example: includeTripUpdates=false

Whether or not to include TripUpdates in the response

startDate
string <date>
Example: startDate=2022-03-03

The date (inclusive) from which to return the records. Must be <= endDate.

endDate
string <date>
Example: endDate=2022-03-03

The date (inclusive) from which to return the records. Must be >= startDate.

tripIds
Array of strings <uuid> [ items <uuid > ]
Example: tripIds=41f10b92-0e8a-4eb4-a17f-c20e7f124999&tripIds=fdb77302-68a9-4ce1-a2d7-4b42b3b36dcd

An array of Trip IDs to limit the returned Trips by

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

List Defects for a TripUpdate

Returns all Defects that belong to the TripUpdate with the passed ID, ordered by dueDate ascending

path Parameters
id
required
string <uuid>

The id of the TripUpdate to fetch all Defects for

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

defectTypes[]
Array of any
Default: "CAS&defectTypes[]=CDL&defectTypes[]=MEL&defectTypes[]=NEF&defectTypes[]=Other"
Items Enum: "CAS" "CDL" "MEL" "NEF" "Other"
Example: defectTypes[]=CAS&defectTypes[]=MEL

An array of defect types to filter the returned Defects by.

rectificationCategories[]
Array of any
Default: "A&rectificationCategories[]=ADVISORYONLY&rectificationCategories[]=B&rectificationCategories[]=C&rectificationCategories[]=D&rectificationCategories[]=NONDEFERRED"
Items Enum: "A" "ADVISORYONLY" "B" "C" "D" "NONDEFERRED"
Example: rectificationCategories[]=B&rectificationCategories[]=C

An array of rectification categories to filter the returned Defects by.

statuses[]
Array of any
Items Enum: "open" "resolved" "overdue" "deferral_pending" "resolution_pending"
Example: statuses[]=overdue&statuses[]=resolved

An array of statuses to filter the returned Defects by.

updatedAfter
string <date-time>
Example: updatedAfter=2022-02-14T11:08:00Z

Will only return records that have been updated at or after this datetime

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Update a tripUpdate by ID

Update a tripUpdate

path Parameters
id
required
string
Example: 09610b42-5e89-4eb4-a17f-c20e7f772676

ID of tripUpdate being updated

Request Body schema: application/json
required
date
string <date>
number
integer <int32>
srpNumber
integer <int32>
object
object
object

Responses

Request samples

Content type
application/json
{
  • "date": "2022-07-07",
  • "number": 1,
  • "srpNumber": 1,
  • "customData": {
    },
  • "utilisation": {
    },
  • "carriedForwardsOverride": {
    }
}

Response samples

Content type
application/json
{
  • "id": "c11a0129-6811-4c9f-8004-4baf12de6999",
  • "aircraftId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "date": "2022-07-07",
  • "number": 1,
  • "srpNumber": 1,
  • "customData": {
    },
  • "utilisation": {
    },
  • "carriedForwardsOverride": {
    },
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z"
}

Find a tripUpdate by ID

Find a tripUpdate based on ID

path Parameters
id
required
string
Example: 09610b42-5e89-4eb4-a17f-c20e7f772676

ID of tripUpdate being requested

Responses

Response samples

Content type
application/json
{
  • "id": "c11a0129-6811-4c9f-8004-4baf12de6999",
  • "aircraftId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "date": "2022-07-07",
  • "number": 1,
  • "srpNumber": 1,
  • "customData": {
    },
  • "utilisation": {
    },
  • "carriedForwardsOverride": {
    },
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z"
}

Delete a tripUpdate by ID

Delete a tripUpdate based on ID

path Parameters
id
required
string
Example: 09610b42-5e89-4eb4-a17f-c20e7f772676

ID of tripUpdate being deleted

Responses

Response samples

Content type
application/problem+json
Example
{}

Add a new TripUpdate

Creates a TripUpdate

Request Body schema: application/json
required
aircraftId
required
string <uuid>
date
required
string <date>
number
integer <int32>
srpNumber
integer <int32>
object
object
object

Responses

Request samples

Content type
application/json
{
  • "aircraftId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "date": "2022-07-07",
  • "number": 1,
  • "srpNumber": 1,
  • "customData": {
    },
  • "utilisation": {
    },
  • "carriedForwardsOverride": {
    }
}

Response samples

Content type
application/json
{
  • "id": "c11a0129-6811-4c9f-8004-4baf12de6999",
  • "aircraftId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "date": "2022-07-07",
  • "number": 1,
  • "srpNumber": 1,
  • "customData": {
    },
  • "utilisation": {
    },
  • "carriedForwardsOverride": {
    },
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z"
}

List of TripUpdates

NOT YET AVAILABLE - List of TripUpdates

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Fetch the sector record page PDF for a trip/trip update

Returns a binary representation of the trip/trip update's sector record page list in PDF format

path Parameters
id
required
string <uuid>

ID of trip/trip update to use

Responses

Response samples

Content type
application/problem+json
Example
{}

UserCapabilities

Endpoints associated with UserCapabilities

List User Capabilities

Returns all User Capabilities

path Parameters
id
required
string
Example: 8ab08a0a-0c12-4d87-93c5-e046362b5f77

ID of user being queried

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update User Capabilities

Updates User Capabilities. The value of userCapabilities body attribute must be an array of objects. In order to give a user a specific capability, you must pass the capabilityId. In order to remove a capability, you must pass the id of the existing UserCapability with _destroy set to true.

path Parameters
id
required
string
Example: 8ab08a0a-0c12-4d87-93c5-e046362b5f77

ID of user for which the capabilities are being updated

Request Body schema: application/json
required
Array of objects or objects

Responses

Request samples

Content type
application/json
{
  • "userCapabilities": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Users

Anyone who uses Trustflight systems. Includes flight crew, maintenance and administrative staff

Returns all User that belong the the requested Operator

List User by Operator ID

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

email
string
Example: email=@example.com

Filter users by a full or partial email address

position
Array of strings (UserPosition)
Default: "Admin&position=Pilot&position=OpsController&position=Camo&position=Crew&position=Engineer&position=ReliefPilot&position=FlightAttendant"
Items Enum: "Admin" "Pilot" "OpsController" "Camo" "Crew" "Engineer" "ReliefPilot" "FlightAttendant"
Example: position=Pilot&position=ReliefPilot

Not yet available - Filter users by their position

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Create a person role

Create a role that a person can assume, scoped to the current operator. Required to add AdditionalPeople. A list of existing PersonRoles can be found on the operator endpoints.

Request Body schema: application/json
required
name
required
string
crewType
required
string
Enum: "Flight" "Cabin" "Maintenance"

Within TechLog, this is a label only, but it may be used by third party integrations

positions
required
Array of strings (UserPosition) non-empty
Items Enum: "Admin" "Pilot" "OpsController" "Camo" "Crew" "Engineer" "ReliefPilot" "FlightAttendant"

Only users whose position attribute is in this field, are allowed to perform this role

dutyTracked
boolean
Default: false

Set true if you want users who use this role to have their duty tracked by TechLog

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "crewType": "Flight",
  • "positions": [
    ],
  • "dutyTracked": false
}

Response samples

Content type
application/json
{
  • "id": "3da49b42-5e89-4eb4-a17f-c20e7f122676",
  • "name": "string",
  • "crewType": "Flight",
  • "positions": [
    ],
  • "dutyTracked": false,
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z"
}

Create a user, without an associated Login

Create a user

Request Body schema: application/json
required
firstName
required
string
lastName
required
string
email
required
string
position
required
string (UserPosition)
Enum: "Admin" "Pilot" "OpsController" "Camo" "Crew" "Engineer" "ReliefPilot" "FlightAttendant"
employeeNumber
string
amosUserSign
string

Responses

Request samples

Content type
application/json
{
  • "firstName": "John",
  • "lastName": "Smith",
  • "email": "johnsmith@example.com",
  • "position": "Admin",
  • "employeeNumber": "ABC123",
  • "amosUserSign": "LF44"
}

Response samples

Content type
application/json
{
  • "id": "c11a0129-6811-4c9f-8004-4bafe2de6999",
  • "operatorId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "firstName": "John",
  • "lastName": "Smith",
  • "email": "johnsmith@example.com",
  • "position": "Admin",
  • "employeeNumber": "ABC123",
  • "amosUserSign": "LF44",
  • "status": "Active",
  • "hasLogin": true,
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z"
}

Update a user

Update a user

path Parameters
id
required
string
Example: 8ab08a0a-0c12-4d87-93c5-e046362b5f77

ID of user being queried

Request Body schema: application/json
required
firstName
string
lastName
string
position
string (UserPosition)
Enum: "Admin" "Pilot" "OpsController" "Camo" "Crew" "Engineer" "ReliefPilot" "FlightAttendant"
employeeNumber
string

Responses

Request samples

Content type
application/json
{
  • "firstName": "John",
  • "lastName": "Smith",
  • "position": "Admin",
  • "employeeNumber": "ABC123"
}

Response samples

Content type
application/json
{
  • "id": "c11a0129-6811-4c9f-8004-4bafe2de6999",
  • "operatorId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "firstName": "John",
  • "lastName": "Smith",
  • "email": "johnsmith@example.com",
  • "position": "Admin",
  • "employeeNumber": "ABC123",
  • "amosUserSign": "LF44",
  • "status": "Active",
  • "hasLogin": true,
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z"
}

Find user by ID

Get the details of a user by ID

path Parameters
id
required
string
Example: 8ab08a0a-0c12-4d87-93c5-e046362b5f77

ID of user being queried

Responses

Response samples

Content type
application/json
{
  • "id": "c11a0129-6811-4c9f-8004-4bafe2de6999",
  • "operatorId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "firstName": "John",
  • "lastName": "Smith",
  • "email": "johnsmith@example.com",
  • "position": "Admin",
  • "employeeNumber": "ABC123",
  • "amosUserSign": "LF44",
  • "status": "Active",
  • "hasLogin": true,
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z"
}

Delete a User

Deletes a User based on ID

IMPORTANT: Deleting a user through this endpoint will prevent that user from having access to any previously accessible aircraft if they are able to log in to the system.

path Parameters
id
required
string <uuid>

The id of the User to delete

Responses

Response samples

Content type
application/problem+json
Example
{}

List User Capabilities

Returns all User Capabilities

path Parameters
id
required
string
Example: 8ab08a0a-0c12-4d87-93c5-e046362b5f77

ID of user being queried

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update User Capabilities

Updates User Capabilities. The value of userCapabilities body attribute must be an array of objects. In order to give a user a specific capability, you must pass the capabilityId. In order to remove a capability, you must pass the id of the existing UserCapability with _destroy set to true.

path Parameters
id
required
string
Example: 8ab08a0a-0c12-4d87-93c5-e046362b5f77

ID of user for which the capabilities are being updated

Request Body schema: application/json
required
Array of objects or objects

Responses

Request samples

Content type
application/json
{
  • "userCapabilities": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Workpacks

A set of maintenance tasks that are performed on an aircraft during a specified maintenance period. These are made up of Defects and ScheduledMxItems

Find workpacks by aircraft ID

Returns workpacks for a given aircraft ID

path Parameters
id
required
string <uuid>

ID of aircraft to use

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

startDate
string <date>
Example: startDate=2022-03-03

The date (inclusive) from which to return the records. Must be <= endDate.

endDate
string <date>
Example: endDate=2022-03-03

The date (inclusive) from which to return the records. Must be >= startDate.

status
Array of strings
Default: "pending&status=draft&status=active&status=complete"
Items Enum: "pending" "draft" "active" "complete"
Example: status=active&status=complete

An array of statuses to limit the returned Workpacks by

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Add a Workpack against an Aircraft

Creates a Workpack against the Aircraft with the passed ID

path Parameters
id
required
string <uuid>

The id of the Aircraft to create the Workpack against

Request Body schema: application/json
required
status
string
Enum: "draft" "active" "complete" "pending"
description
string
source
string
Enum: "trustflight" "camp"
notes
string
reference
string
date
string
poNumber
string
mxItemIds
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "status": "draft",
  • "description": "RH/LH Landing Light Replacement",
  • "source": "trustflight",
  • "notes": "some notes against the workpack",
  • "reference": "KCAS-20-002",
  • "date": "2022-02-02T07:08:00Z",
  • "poNumber": "ILBG-20-123",
  • "mxItemIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "c11a0129-6811-4c9f-8004-4bafe2de6999",
  • "aircraftId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "status": "draft",
  • "description": "RH/LH Landing Light Replacement",
  • "source": "trustflight",
  • "notes": "some notes against the workpack",
  • "reference": "KCAS-20-002",
  • "date": "2022-02-02T07:08:00Z",
  • "poNumber": "ILBG-20-123",
  • "mxItemIds": [
    ],
  • "releaseDate": "2022-02-02T07:08:00Z",
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z"
}

Add a release against workpack

Creates release against workpack with passed id

path Parameters
id
required
string <uuid>

The id of the Workpack

Request Body schema: application/json
required
companyEmail
string
licenceNumber
string
firstName
string
lastName
string
reporterFirstName
string
reporterLastName
string
approvalNumber
string
companyName
string
reference
string
date
string <date>
signeeType
string (SigneeType)
Enum: "crewDetails" "engineerDetails" "crsDocument"
approverFirstName
string
approverLastName
string

Responses

Request samples

Content type
application/json
{
  • "companyEmail": "company@example.com",
  • "licenceNumber": "Example-123",
  • "firstName": "John",
  • "lastName": "Smith",
  • "reporterFirstName": "John",
  • "reporterLastName": "Smith",
  • "approvalNumber": "Example-123",
  • "companyName": "ExampleCompany",
  • "reference": "Example-123",
  • "date": "2022-07-07",
  • "signeeType": "crewDetails",
  • "approverFirstName": "John",
  • "approverLastName": "Smith"
}

Response samples

Content type
application/json
{
  • "id": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "aircraftId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "operatorId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "workpackId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "openDefectIds": [
    ],
  • "additionalItems": [
    ],
  • "mxItemIds": [
    ],
  • "date": "2022-07-07T15:37:00Z",
  • "companyName": "ExampleCompany",
  • "approvalNumber": "Example-123",
  • "firstName": "John",
  • "lastName": "Smith",
  • "licenceNumber": "Example-123",
  • "companyEmail": "company@example.com",
  • "customData": { },
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z",
  • "reference": "Example-123",
  • "reporterFirstName": "John",
  • "reporterLastName": "Smith",
  • "approverFirstName": "John",
  • "approverLastName": "Smith",
  • "signeeType": "crewDetails",
  • "attachments": [
    ],
  • "approvalReleaseRequired": false,
  • "approvedById": "01610b42-5e89-4eb4-a17f-c20e7f7d2676"
}

Get all workpacks matching given criteria

query Parameters
page
integer <int32> >= 1
Default: 1

The current page of results

perPage
integer <int32> [ 1 .. 50 ]
Default: 10

The number of items to return

updatedAfter
string <date-time>
Example: updatedAfter=2022-02-14T11:08:00Z

Will only return records that have been updated at or after this datetime

Responses

Response samples

Content type
application/json
{
  • "total": 100,
  • "page": 1,
  • "perPage": 10,
  • "hasNext": true,
  • "hasPrev": false,
  • "results": [
    ]
}

Get a Workpack

Retrieve a Workpack based on ID

path Parameters
id
required
string <uuid>

ID of Workpack to update

Responses

Response samples

Content type
application/json
{
  • "id": "c11a0129-6811-4c9f-8004-4bafe2de6999",
  • "aircraftId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "status": "draft",
  • "description": "RH/LH Landing Light Replacement",
  • "source": "trustflight",
  • "notes": "some notes against the workpack",
  • "reference": "KCAS-20-002",
  • "date": "2022-02-02T07:08:00Z",
  • "poNumber": "ILBG-20-123",
  • "mxItemIds": [
    ],
  • "releaseDate": "2022-02-02T07:08:00Z",
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z"
}

Updates a Workpack

Updates a Workpack based on ID

path Parameters
id
required
string <uuid>

ID of Workpack to update

Request Body schema: application/json
required
status
string
Enum: "draft" "active" "complete" "pending"
description
string
source
string
Enum: "trustflight" "camp"
notes
string
reference
string
date
string
poNumber
string
mxItemIds
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "status": "draft",
  • "description": "RH/LH Landing Light Replacement",
  • "source": "trustflight",
  • "notes": "some notes against the workpack",
  • "reference": "KCAS-20-002",
  • "date": "2022-02-02T07:08:00Z",
  • "poNumber": "ILBG-20-123",
  • "mxItemIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "c11a0129-6811-4c9f-8004-4bafe2de6999",
  • "aircraftId": "21610b42-5e89-4eb4-c28b-a111aaabbbcc",
  • "status": "draft",
  • "description": "RH/LH Landing Light Replacement",
  • "source": "trustflight",
  • "notes": "some notes against the workpack",
  • "reference": "KCAS-20-002",
  • "date": "2022-02-02T07:08:00Z",
  • "poNumber": "ILBG-20-123",
  • "mxItemIds": [
    ],
  • "releaseDate": "2022-02-02T07:08:00Z",
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z"
}

Delete a Workpack by ID

Delete a Workpack by ID

path Parameters
id
required
string <uuid>

The id of the Workpack

Responses

Response samples

Content type
application/problem+json
Example
{}

Active Endpoints

Add a new sector

Creates a sector (with corrected pilot fields)

Request Body schema: application/json
required
tripId
string <uuid>
departureAirportId
integer <int32>
arrivalAirportId
integer <int32>
actualArrivalAirportId
integer <int32>
pilotInCommandId
string <uuid>
secondInCommandId
string <uuid>
pilotPerformingTakeoffId
string <uuid>
pilotPerformingLandingId
string <uuid>
userId
string <uuid>
apuSeconds
integer <int32>
apuReading
integer <int32>
apuCyclesReading
integer <int32>
hobbsDeparture
number <double>
hobbsArrival
number <double>
offblocksTime
string <date-time>
takeoffTime
string <date-time>
landingTime
string <date-time>
onblocksTime
string <date-time>
landingsCount
integer
preflightCustomData
object

An object containing custom preflight data for the sector

postflightCustomData
object

An object containing custom postflight data for the sector

pilotFlyingId
string <uuid>
pilotMonitoringId
string <uuid>
Array of objects (FluidUpliftBody)
Array of objects (FuelUpliftBody)
Array of objects (DeiceEventBody)

Responses

Request samples

Content type
application/json
{
  • "tripId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "departureAirportId": 1,
  • "arrivalAirportId": 1,
  • "actualArrivalAirportId": 1,
  • "pilotInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "secondInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotPerformingTakeoffId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotPerformingLandingId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "userId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "apuSeconds": 1,
  • "apuReading": 1,
  • "apuCyclesReading": 1,
  • "hobbsDeparture": 1.5,
  • "hobbsArrival": 2.5,
  • "offblocksTime": "2022-07-07T13:37:00Z",
  • "takeoffTime": "2022-07-07T14:37:00Z",
  • "landingTime": "2022-07-07T15:37:00Z",
  • "onblocksTime": "2022-07-07T16:37:00Z",
  • "landingsCount": 1,
  • "preflightCustomData": {
    },
  • "postflightCustomData": {
    },
  • "pilotFlyingId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotMonitoringId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "fluidUplifts": [
    ],
  • "fuelUplifts": [
    ],
  • "deiceEvents": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "tripId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "departureAirportId": 1,
  • "arrivalAirportId": 2,
  • "actualArrivalAirportId": 3,
  • "pilotInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "secondInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotPerformingTakeoffId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotPerformingLandingId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "userId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "apuSeconds": 1,
  • "apuReading": 1,
  • "apuCyclesReading": 1,
  • "hobbsDeparture": 1.5,
  • "hobbsArrival": 2.5,
  • "offblocksTime": "2022-07-07T13:37:00Z",
  • "takeoffTime": "2022-07-07T14:37:00Z",
  • "landingTime": "2022-07-07T15:37:00Z",
  • "onblocksTime": "2022-07-07T16:37:00Z",
  • "landingsCount": 1,
  • "takeoffsCount": 1,
  • "status": "partial",
  • "flightType": "training",
  • "remarks": "hi",
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z",
  • "date": "2022-01-02T07:08:00Z",
  • "source": "techlogApp",
  • "preflightCustomData": {
    },
  • "postflightCustomData": {
    },
  • "cycles": {
    },
  • "passengersMale": 1,
  • "passengersFemale": 1,
  • "passengersChildren": 1,
  • "passengersInfants": 1,
  • "baggageWeight": 1,
  • "gpuStart": "00:00:00",
  • "gpuEnd": "00:00:00",
  • "gpuSeconds": 1,
  • "maxFlightLevel": 1,
  • "pressurisedCycle": true,
  • "preflightMxCheckIds": [
    ],
  • "abandonmentReason": "technicalFailure",
  • "attachments": [
    ],
  • "fratScore": 50,
  • "plannedFuelBurn": 200,
  • "actualFuelBurn": 200,
  • "fuelBurnJustification": "Increased taxi length",
  • "pilotFlyingId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotMonitoringId": "01610b42-5e89-4eb4-a17f-c20e7f772676"
}

Update sector by ID

Updates a sector based on ID (with corrected pilot fields)

Note: The preflightCustomData & postflightCustomData objects will overwrite what is currently stored. It will not merge their contents.

path Parameters
id
required
string

ID of sector to use

Request Body schema: application/json
required
departureAirportId
integer <int32>
arrivalAirportId
integer <int32>
actualArrivalAirportId
integer <int32>
pilotInCommandId
string <uuid>
secondInCommandId
string <uuid>
pilotPerformingTakeoffId
string <uuid>
pilotPerformingLandingId
string <uuid>
userId
string <uuid>
apuSeconds
integer <int32>
apuReading
integer <int32>
apuCyclesReading
integer <int32>
hobbsDeparture
number <double>
hobbsArrival
number <double>
offblocksTime
string <date-time>
takeoffTime
string <date-time>
landingTime
string <date-time>
onblocksTime
string <date-time>
landingsCount
integer
preflightCustomData
object

An object containing custom preflight data for the sector

postflightCustomData
object

An object containing custom postflight data for the sector

pilotFlyingId
string <uuid>
pilotMonitoringId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "departureAirportId": 1,
  • "arrivalAirportId": 1,
  • "actualArrivalAirportId": 1,
  • "pilotInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "secondInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotPerformingTakeoffId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotPerformingLandingId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "userId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "apuSeconds": 1,
  • "apuReading": 1,
  • "apuCyclesReading": 1,
  • "hobbsDeparture": 1.5,
  • "hobbsArrival": 2.5,
  • "offblocksTime": "2022-07-07T13:37:00Z",
  • "takeoffTime": "2022-07-07T14:37:00Z",
  • "landingTime": "2022-07-07T15:37:00Z",
  • "onblocksTime": "2022-07-07T16:37:00Z",
  • "landingsCount": 1,
  • "preflightCustomData": {
    },
  • "postflightCustomData": {
    },
  • "pilotFlyingId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotMonitoringId": "01610b42-5e89-4eb4-a17f-c20e7f772676"
}

Response samples

Content type
application/json
{
  • "id": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "tripId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "departureAirportId": 1,
  • "arrivalAirportId": 2,
  • "actualArrivalAirportId": 3,
  • "pilotInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "secondInCommandId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotPerformingTakeoffId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotPerformingLandingId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "userId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "apuSeconds": 1,
  • "apuReading": 1,
  • "apuCyclesReading": 1,
  • "hobbsDeparture": 1.5,
  • "hobbsArrival": 2.5,
  • "offblocksTime": "2022-07-07T13:37:00Z",
  • "takeoffTime": "2022-07-07T14:37:00Z",
  • "landingTime": "2022-07-07T15:37:00Z",
  • "onblocksTime": "2022-07-07T16:37:00Z",
  • "landingsCount": 1,
  • "takeoffsCount": 1,
  • "status": "partial",
  • "flightType": "training",
  • "remarks": "hi",
  • "createdAt": "2022-02-02T07:08:00Z",
  • "updatedAt": "2022-03-03T07:08:00Z",
  • "date": "2022-01-02T07:08:00Z",
  • "source": "techlogApp",
  • "preflightCustomData": {
    },
  • "postflightCustomData": {
    },
  • "cycles": {
    },
  • "passengersMale": 1,
  • "passengersFemale": 1,
  • "passengersChildren": 1,
  • "passengersInfants": 1,
  • "baggageWeight": 1,
  • "gpuStart": "00:00:00",
  • "gpuEnd": "00:00:00",
  • "gpuSeconds": 1,
  • "maxFlightLevel": 1,
  • "pressurisedCycle": true,
  • "preflightMxCheckIds": [
    ],
  • "abandonmentReason": "technicalFailure",
  • "attachments": [
    ],
  • "fratScore": 50,
  • "plannedFuelBurn": 200,
  • "actualFuelBurn": 200,
  • "fuelBurnJustification": "Increased taxi length",
  • "pilotFlyingId": "01610b42-5e89-4eb4-a17f-c20e7f772676",
  • "pilotMonitoringId": "01610b42-5e89-4eb4-a17f-c20e7f772676"
}