Vous êtes sur la page 1sur 15

LogTen Pro API

Coradine Aviation Systems proudly presents the LogTen Pro Application Programming
Interface (API) v1.1 which allows third-party applications to interact with LogTen Pro
using a straight forward URL based approach using JSON (JavaScript Object Notation).
The LogTen Pro API v1.1 is available starting with the following versions of the software:
LogTen Pro Mac v5.7.0
LogTen Pro iPhone v3.2.0
LogTen Pro iPad v1.2.0
LogTen Pro is registered to handle requests to the logten:// URI scheme. Any
requests made to the logten:// scheme will be passed off to LogTen Pro for handling.
The general format of the request is as follows:
logten://method/{json_payload}

Coradine Aviation Systems


4039 N Mississippi Ave
Suite 303
Portland, OR 97227
info@coradine.com
www.coradine.com

The json_payload shall always contain a metadata dictionary. The metadata dictionary
must always contain the requesting application name as well as the requesting
applications version information. Depending on the actual method invoked, the
metadata may contain optional parameters.
logten://method/{"metadata":{"application":"My Application",
"version":"1.0", "optional_parameter":"some_value"}, ...}
Notes:
1. You must be sure to escape any special JSON characters in your JSON payload to
ensure proper parsing by LogTen Pro. If any of your values contains a single quote,
double quote or a backslash, you will need to prepend a backslash to that character in
the payload. For instance if your value was
"
My data contains a \ and a .
it would become
"
My data contains a \\ and a \.
2. The complete URL should have any characters escaped that are not legal URL
characters (based on RFC 2396). In Cocoa, this can easily be accomplished by
running the NSStrings - (NSString *) stringByAddingPercentEscapesUsingEncoding:
(NSStringEncoding)encoding method on the URL string with the
NSUTF8StringEncoding encoding.

Identifying flights
LogTen Pro utilizes the flight_key attribute on the flight entity to uniquely identify flights
provided from an external source. The flight_key attribute is a string value and is required
to be unique for a given logbook. When a flight record is sent through the API that
includes a flight_key, LogTen Pro will first attempt to locate a matching flight with that
flight_key. If a create or modify operation is being run and a matching flight already
exists with that flight_key, that flight will be modified with the provided data. If a matching
flight is not found, a new one will be created with the provided data. For removal
operations, only flights with the matching flight_key will be removed. Please note: If the
matching flight is locked (flight_isLocked is set to 1), the flight will not be modified or deleted.

Coradine Aviation Systems - LogTen Pro API v1.1 - 7/15/11

v1.1 Supported Methods


addFlights
The addFlights method allows a third-party application to create/modify flights within the
LogTen Pro logbook. When the addFlights method is invoked, LogTen Pro will ask the
user if they wish to create/modify the flights from the requesting application.
The addFlights method expects the metadata dictionary and a collection of flights.
logten://addFlights/{"metadata":{"application":"My App",
"version":"1.0", ...}, "flights":[{flight1 info...}, {flight2
info...}, ...]}
metadata:
The addFlights method allows three optional parameters in the metadata dictionary:
dateFormat - The dateFormat parameter specifies how date values should be parsed
when they are passed in as string values. The date format string uses
the format patterns recognized by the NSDateFormatter class (i.e.
MM/dd/yyyy).
Coradine Aviation Systems
4039 N Mississippi Ave
Suite 303
Portland, OR 97227
info@coradine.com
www.coradine.com

dateAndTimeFormat - The dateAndTimeFormat parameter specifies how date values


should be parsed when they are passed in as string values. The date
and time format string uses the format patterns recognized by the
NSDateFormatter class (i.e. MM/dd/yyyy HH:mm).
timesAreZulu - The timesAreZulu parameter specifies whether any passed in string
time values are in Zulu time or should be converted to local time based
on the time zone of the departure or arrival airports. Valid values for the
timesAreZulu parameter are true or false. If this parameter is not
supplied, the default value is true.
flights:
The flights collection shall contain the flight information for each flight to be created/
modified. If a flight_key value is provided for a given flight, LogTen Pro will first attempt
to locate a flight in the logbook matching the flight_key. If a matching flight is found, that
flight will be updated with the provided attributes. If a matching flight is not found, a new
flight will be created. Any of the valid LogTen Pro flight attributes are available for use
(see Appendix for the current, complete list of relevant flight attributes).
The addFlights method will allow flight time values to be supplied as either the decimal
number of hours (i.e. 1.5), the number of hours and minutes separated by a colon (i.e.
1:30) or the number of hours and minutes separated by a plus sign (i.e. 1+30).
The addFlights method will allow date values to be supplied as either a string value that
matches the dateFormat parameter supplied in the metadata or as the number of
seconds from the unix epoch (this value can be returned using the NSDate
timeIntervalSince1970 method in Cocoa).
The addFlights method will allow date/time values to be to be supplied as either a string
value that matches the dateAndTimeFormat parameter supplied in the metadata or as
the number of seconds from the unix epoch (this value can be returned using the NSDate
timeIntervalSince1970 method in Cocoa). The timesAreZulu parameter is only

Coradine Aviation Systems - LogTen Pro API v1.1 - 7/15/11

applicable to date/time values that are passed in as strings. When handling local times,
the addFlights method will first attempt to obtain the time zone for the applicable to or
from place (depending on the attribute being set). If there is no corresponding place or it
does not have a time zone associated with it, the addFlights method will attempt to use
the default timezone set for LogTen Pro. If there is no default timezone configured, the
addFlights method will use GMT.
The following is an example of a valid addFlights request:
logten://addFlights/{"metadata":{"application":"My Application",
"version":"1.0", "dateFormat":"MM/dd/yyyy",
"dateAndTimeFormat":"MM/dd/yyyy HH:mm", "timesAreZulu":"true"},
"flights":[{"flight_flightDate":"12/25/2010", "flight_to":
"KPIT", "flight_from":"KPJC", "flight_pic":"1:30",
"flight_takeoffTime":"12/25/2010 15:50"}]}

modifyFlights
The modifyFlights method allows a third-party application to create, modify and remove
flights within the LogTen Pro logbook. When the modifyFlights method is invoked,
LogTen Pro will ask the user if they wish to create/modify and remove the flights from the
requesting application.
Coradine Aviation Systems
4039 N Mississippi Ave
Suite 303
Portland, OR 97227
info@coradine.com
www.coradine.com

The modifyFlights method expects the metadata dictionary, a collection of flights to


create/modify and collection of flights to remove. The modifyFlights method requires at
least both collections to be present, however it is valid to send empty collections.
logten://modifyFlights/{"metadata":{"application":"My App",
"version":"1.0", ...}, "flights":[{flight1 info...}, {flight2
info...}, ...], "removeFlights":[{flight1 flight_key}, {flight2
flight_key}, ...]}
metadata:
The modifyFlights method allows three optional parameters in the metadata dictionary:
dateFormat - The dateFormat parameter specifies how date values should be parsed
when they are passed in as string values. The date format string uses
the format patterns recognized by the NSDateFormatter class (i.e.
MM/dd/yyyy).
dateAndTimeFormat - The dateAndTimeFormat parameter specifies how date values
should be parsed when they are passed in as string values. The date
and time format string uses the format patterns recognized by the
NSDateFormatter class (i.e. MM/dd/yyyy HH:mm).
timesAreZulu - The timesAreZulu parameter specifies whether any passed in string
time values are in Zulu time or should be converted to local time based
on the time zone of the departure or arrival airports. Valid values for the
timesAreZulu parameter are true or false. If this parameter is not
supplied, the default value is true.
flights:
The flights collection shall contain the flight information for each flight to be created/
modified. If a flight_key value is provided for a given flight, LogTen Pro will first attempt
to locate a flight in the logbook matching the flight_key. If a matching flight is found, that
flight will be updated with the provided attributes. If a matching flight is not found, a new

Coradine Aviation Systems - LogTen Pro API v1.1 - 7/15/11

flight will be created. Any of the valid LogTen Pro flight attributes are available for use
(see Appendix for the current, complete list of relevant flight attributes).
The modifyFlights method will allow flight time values to be supplied as either the
decimal number of hours (i.e. 1.5), the number of hours and minutes separated by a
colon (i.e. 1:30) or the number of hours and minutes separated by a plus sign (i.e.
1+30).
The modifyFlights method will allow date values to be supplied as either a string value
that matches the dateFormat parameter supplied in the metadata or as the number of
seconds from the unix epoch (this value can be returned using the NSDate
timeIntervalSince1970 method in Cocoa).

Coradine Aviation Systems


4039 N Mississippi Ave
Suite 303
Portland, OR 97227
info@coradine.com
www.coradine.com

The modifyFlights method will allow date/time values to be to be supplied as either a


string value that matches the dateAndTimeFormat parameter supplied in the metadata
or as the number of seconds from the unix epoch (this value can be returned using the
NSDate timeIntervalSince1970 method in Cocoa). The timesAreZulu parameter is only
applicable to date/time values that are passed in as strings. When handling local times,
the modifyFlights method will first attempt to obtain the time zone for the applicable to or
from place (depending on the attribute being set). If there is no corresponding place or it
does not have a time zone associated with it, the modifyFlights method will attempt to
use the default timezone set for LogTen Pro. If there is no default timezone configured,
the modifyFlights method will use GMT.
removeFlights:
The removeFlights collection shall contain the flight_key for each flight to be removed.
The following is an example of a valid modifyFlights request:
logten://modifyFlights/{"metadata":{"application":"My
Application", "version":"1.0", "dateFormat":"MM/dd/yyyy",
"dateAndTimeFormat":"MM/dd/yyyy HH:mm", "timesAreZulu":"true"},
"flights":[{"flight_key":"myAppFlight_101",
"flight_flightDate":"12/25/2010", "flight_to": "KPIT",
"flight_from":"KPJC", "flight_pic":"1:30",
"flight_takeoffTime":"12/25/2010 15:50"}], "removeFlights":
[{"flight_key":"myAppFlight_101"},
{"flight_key":"myAppFlight_102"}]}

Coradine Aviation Systems - LogTen Pro API v1.1 - 7/15/11

Appendix: Valid attributes


Flights
General Attributes:
Attribute

Coradine Aviation Systems


4039 N Mississippi Ave
Suite 303
Portland, OR 97227
info@coradine.com
www.coradine.com

Data Type

Notes

flight_key

String

flight_cloudbase

Number

flight_customNote1

String

flight_customNote2

String

flight_customNote3

String

flight_customNote4

String

flight_customNote5

String

flight_distance

Number

flight_dutyTimePayRate

Number

flight_expenses

Number

flight_flagged

Number

flight_flightNumber

String

flight_flightTimePayRate

Number

flight_fuelBurned

Number

flight_hobbsStart

Number

flight_hobbsStop

Number

flight_instrumentProficiencyCheck

Number

0 or 1

flight_isLocked

Number

0 or 1

flight_leg

Number

flight_nightVisionSystem

Number

flight_payload

Number

flight_remarks

String

flight_review

Number

flight_scheduledTimePayRate

Number

Coradine Aviation Systems - LogTen Pro API v1.1 - 7/15/11

Uniquely identifies a flight created


from an external source

0 or 1

0 or 1

Attribute

Data Type

flight_sky

String

flight_tachStart

Number

flight_tachStop

Number

flight_totalEarned

Number

flight_visibility

Number

flight_weather

String

flight_windDirection

Number

flight_windVelocity

Number

Notes

Dates and Times:


Attribute
Coradine Aviation Systems
4039 N Mississippi Ave
Suite 303
Portland, OR 97227
info@coradine.com
www.coradine.com

Data Type

flight_actualArrivalTime

DateTime

flight_actualDepartureTime

DateTime

flight_flightDate

DateTime

flight_landingTime

DateTime

flight_offDutyTime

DateTime

flight_onDutyTime

DateTime

flight_scheduledArrivalTime

DateTime

flight_scheduledDepartureTime

DateTime

flight_takeoffTime

DateTime

Notes

Flight Times:
Attribute

Data Type

flight_actualInstrument

Number

flight_aircraftClass1

Number

flight_aircraftClass2

Number

flight_aircraftClass3

Number

flight_aircraftClass4

Number

flight_aircraftClass5

Number

Coradine Aviation Systems - LogTen Pro API v1.1 - 7/15/11

Notes

Attribute

Coradine Aviation Systems


4039 N Mississippi Ave
Suite 303
Portland, OR 97227
info@coradine.com
www.coradine.com

Data Type

flight_aircraftClass6

Number

flight_aircraftClass7

Number

flight_aircraftClass8

Number

flight_aircraftClass9

Number

flight_aircraftClass10

Number

flight_aircraftClass11

Number

flight_aircraftClass12

Number

flight_aircraftClass13

Number

flight_aircraftClass14

Number

flight_aircraftClass15

Number

flight_category1

Number

flight_category2

Number

flight_category3

Number

flight_category4

Number

flight_category5

Number

flight_category6

Number

flight_category7

Number

flight_category8

Number

flight_category9

Number

flight_category10

Number

flight_category11

Number

flight_category12

Number

flight_category13

Number

flight_category14

Number

flight_category15

Number

flight_commandPractice

Number

flight_crossCountry

Number

flight_customTime1

Number

Coradine Aviation Systems - LogTen Pro API v1.1 - 7/15/11

Notes

Attribute

Coradine Aviation Systems


4039 N Mississippi Ave
Suite 303
Portland, OR 97227
info@coradine.com
www.coradine.com

Data Type

flight_customTime2

Number

flight_customTime3

Number

flight_customTime4

Number

flight_customTime5

Number

flight_customTime6

Number

flight_customTime7

Number

flight_customTime8

Number

flight_customTime9

Number

flight_customTime10

Number

flight_customTime11

Number

flight_customTime12

Number

flight_customTime13

Number

flight_customTime14

Number

flight_customTime15

Number

flight_customTime16

Number

flight_customTime17

Number

flight_customTime18

Number

flight_customTime19

Number

flight_customTime20

Number

flight_dualGiven

Number

flight_dualReceived

Number

flight_dualReceivedNight

Number

flight_duration

Number

flight_engineType1

Number

flight_engineType2

Number

flight_engineType3

Number

flight_engineType4

Number

flight_engineType5

Number

Coradine Aviation Systems - LogTen Pro API v1.1 - 7/15/11

Notes

Attribute

Coradine Aviation Systems


4039 N Mississippi Ave
Suite 303
Portland, OR 97227
info@coradine.com
www.coradine.com

Data Type

flight_engineType6

Number

flight_engineType7

Number

flight_engineType8

Number

flight_engineType9

Number

flight_engineType10

Number

flight_engineType11

Number

flight_engineType12

Number

flight_engineType13

Number

flight_engineType14

Number

flight_engineType15

Number

flight_flightEngineer

Number

flight_ground

Number

flight_multiPilot

Number

flight_night

Number

flight_nightVisionGoggle

Number

flight_p1us

Number

flight_p1usNight

Number

flight_pic

Number

flight_picNight

Number

flight_relief

Number

flight_scheduledTotalTime

Number

flight_sfi

Number

flight_sic

Number

flight_sicNight

Number

flight_simulatedInstrument

Number

flight_simulator

Number

flight_solo

Number

flight_totalDutyTime

Number

Coradine Aviation Systems - LogTen Pro API v1.1 - 7/15/11

Notes

Attribute

Data Type

flight_totalInstrument

Number

flight_totalTime

Number

Notes

Takeoffs:
Attribute

Coradine Aviation Systems


4039 N Mississippi Ave
Suite 303
Portland, OR 97227
info@coradine.com
www.coradine.com

Data Type

flight_customTakeoff1

Number

flight_customTakeoff2

Number

flight_customTakeoff3

Number

flight_customTakeoff4

Number

flight_customTakeoff5

Number

flight_customTakeoff6

Number

flight_customTakeoff7

Number

flight_customTakeoff8

Number

flight_customTakeoff9

Number

flight_customTakeoff10

Number

flight_dayTakeoffs

Number

flight_nightTakeoffs

Number

flight_nightVisionGoggleTakeoffs

Number

flight_shipboardTakeoffs

Number

flight_totalTakeoffs

Number

flight_waterTakeoffs

Number

Notes

Landings:
Attribute

Data Type

flight_customLanding1

Number

flight_customLanding2

Number

flight_customLanding3

Number

flight_customLanding4

Number

flight_customLanding5

Number

Coradine Aviation Systems - LogTen Pro API v1.1 - 7/15/11

Notes

10

Attribute

Coradine Aviation Systems


4039 N Mississippi Ave
Suite 303
Portland, OR 97227
info@coradine.com
www.coradine.com

Data Type

flight_customLanding6

Number

flight_customLanding7

Number

flight_customLanding8

Number

flight_customLanding9

Number

flight_customLanding10

Number

flight_dayLandings

Number

flight_nightLandings

Number

flight_nightVisionGoggleLandings

Number

flight_shipboardLandings

Number

flight_totalLandings

Number

flight_waterLandings

Number

Notes

Misc Takeoff/Landing:
Attribute

Data Type

flight_arrests

Number

flight_autolands

Number

flight_bolters

Number

flight_catapults

Number

flight_fcls

Number

flight_fullStops

Number

flight_touchAndGoes

Number

Notes

Operations:
Attribute

Data Type

flight_aeroTows

Number

flight_approachPlace

String

flight_approachType

String

flight_catII

Number

flight_catIII

Number

Coradine Aviation Systems - LogTen Pro API v1.1 - 7/15/11

Notes

11

Attribute

Coradine Aviation Systems


4039 N Mississippi Ave
Suite 303
Portland, OR 97227
info@coradine.com
www.coradine.com

Data Type

flight_customOp1

Number

flight_customOp2

Number

flight_customOp3

Number

flight_customOp4

Number

flight_customOp5

Number

flight_customOp6

Number

flight_customOp7

Number

flight_customOp8

Number

flight_customOp9

Number

flight_customOp10

Number

flight_goArounds

Number

flight_groundLaunches

Number

flight_holds

Number

flight_poweredLaunches

Number

flight_totalApproaches

Number

Notes

Capacities:
Attribute

Data Type

Notes

flight_customCapacity1

Number

0 or 1

flight_customCapacity2

Number

0 or 1

flight_customCapacity3

Number

0 or 1

flight_customCapacity4

Number

0 or 1

flight_customCapacity5

Number

0 or 1

flight_customCapacity6

Number

0 or 1

flight_customCapacity7

Number

0 or 1

flight_customCapacity8

Number

0 or 1

flight_customCapacity9

Number

0 or 1

flight_customCapacity10

Number

0 or 1

flight_faaPart61

Number

0 or 1

Coradine Aviation Systems - LogTen Pro API v1.1 - 7/15/11

12

Attribute

Coradine Aviation Systems


4039 N Mississippi Ave
Suite 303
Portland, OR 97227
info@coradine.com
www.coradine.com

Data Type

Notes

flight_faaPart91

Number

0 or 1

flight_faaPart121

Number

0 or 1

flight_faaPart135

Number

0 or 1

flight_far1

Number

0 or 1

flight_flightEngineerCapacity

Number

0 or 1

flight_landingCapacity

Number

0 or 1

flight_picCapacity

Number

0 or 1

flight_pilotFlyingCapacity

Number

0 or 1

flight_reliefCrewCapacity

Number

0 or 1

flight_sicCapacity

Number

0 or 1

flight_underSupervisionCapacity

Number

0 or 1

Aircraft:
Attribute

Data Type

flight_selectedAircraftClass

String

flight_selectedAircraftID

String

flight_selectedAircraftType

String

flight_selectedCategory

String

flight_selectedEngineType

String

flight_selectedMake

String

flight_selectedModel

String

Notes

Crew:
Attribute

Data Type

flight_selectedCrewCommander

String

flight_selectedCrewCustom1

String

flight_selectedCrewCustom2

String

flight_selectedCrewCustom3

String

flight_selectedCrewCustom4

String

Coradine Aviation Systems - LogTen Pro API v1.1 - 7/15/11

Notes

13

Attribute

Coradine Aviation Systems


4039 N Mississippi Ave
Suite 303
Portland, OR 97227
info@coradine.com
www.coradine.com

Data Type

flight_selectedCrewCustom5

String

flight_selectedCrewFlightAttendant

String

flight_selectedCrewFlightAttendant2

String

flight_selectedCrewFlightAttendant3

String

flight_selectedCrewFlightAttendant4

String

flight_selectedCrewFlightEngineer

String

flight_selectedCrewInstructor

String

flight_selectedCrewObserver

String

flight_selectedCrewObserver2

String

flight_selectedCrewPIC

String

flight_selectedCrewPICID

String

flight_selectedCrewPurser

String

flight_selectedCrewRelief

String

flight_selectedCrewRelief2

String

flight_selectedCrewRelief3

String

flight_selectedCrewRelief4

String

flight_selectedCrewSIC

String

flight_selectedCrewSICID

String

flight_selectedCrewStudent

String

Notes

Place:
Attribute

Data Type

flight_from

String

flight_fromCity

String

flight_fromCountry

String

flight_fromState

String

flight_route

String

flight_to

String

flight_toCity

String

Coradine Aviation Systems - LogTen Pro API v1.1 - 7/15/11

Notes

14

Attribute

Data Type

flight_toCountry

String

flight_toState

String

Notes

Coradine Aviation Systems


4039 N Mississippi Ave
Suite 303
Portland, OR 97227
info@coradine.com
www.coradine.com

Coradine Aviation Systems - LogTen Pro API v1.1 - 7/15/11

15

Vous aimerez peut-être aussi