Skip to main content
PUT
Push the pilot's flight totals

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials. Request a token from the token endpoint of the identity provider's domain (https://{cognito-domain}/oauth2/token, with HTTP Basic client authentication) and send it as a Bearer token. Production uses auth.mypilotindex.com. The sandbox uses the dev environment's Cognito domain, which is given to the partner with its sandbox credential. A token carries only the scopes the partner was approved for.

Path Parameters

grant_id
string<uuid>
required

Body

application/json

Maximum 262144 bytes (256 KiB). Unknown or repeated members are rejected at every level.

as_of
string<date-time>
required

The instant of the logbook's state (RFC 3339). Not more than 5 minutes past the server's clock; compared to the microsecond.

types
object[]
required

One row per aircraft type the logbook knows, each type once. It may be empty for a logbook of simulator sessions only: a push carries at least one types row or one simulator row (400 invalid_request otherwise).

Maximum array length: 500
logbook_authority
enum<string>

Informative; the authority whose rules the logbook keeps. Not stored.

Available options:
FAA,
EASA,
ANAC,
TCCA,
CASA,
other
simulator
object[]

Sessions in a flight simulation training device, one row per device class. Kept apart from flight time.

Maximum array length: 5

Response

What the push did. A retry of the last accepted push, and a push that brings nothing new, answer applied 0 and score_requested false.

applied
integer
required

How many of the pilot's figures the push raised: hour columns, and hours in type of the type ratings he holds.

Required range: x >= 0
unchanged
integer
required

How many hour columns of the push the pilot's record already held at or above it.

Required range: x >= 0
dropped
string[]
required

The hour columns left out, sorted, because within the push a column was larger than its parent (for example PIC above total time); its children are left out with it.

score_requested
boolean
required

Whether the pilot's MPI Score is recomputed; true exactly when applied is above zero.