Schedaero API Concepts

Data Model

The Schedaero API primarily makes data available for:


  • Scheduled Trips/Flight Legs - Scheduled flight activities on an aircraft, grouped into trips for a single requester

  • Quoted Trips/Quotes – Cost estimates of 1 or more flight activities, grouped into a quoted trip for a single requester. A quoted trip can have multiple quotes on different aircraft

  • Contacts – Companies or people who are not employees of the Schedaero tenant. Contacts can act as trip requesters or flight leg passengers

Contacts

In Schedaero, a contact is any external person or company that the Schedaero tenant wants to track. Contacts are used as requesters and passengers on trips. Contacts may have relationships between each other: a person may have a company, and a company may have employees.

Relationships For All Contacts

externalIdentities

Optional

Any identifiers for this contact in external systems (/api/externalsystems) linked to Schedaero

trips

Optional

Quoted or scheduled trips (/api/trips) for which this contact is the requester

salesperson

Staff member (/api/staff) that is the assigned salesperson for this contact

Relationships For Contact People

company

Optional

Contact company (/api/contacts/companies) that is this contact’s employer

Relationships For Contact Companies

employees

Optional

Contact people (/api/contacts/people) that are employees of this company

Scheduled Trips

In Schedaero, a flight leg is an aircraft movement between two airports. A scheduled trip is a group of flight legs for a single requester (Contact). Some properties of trips and flight legs are not yet available through the API.


Relationships For a Scheduled Trip

requester

Contact (/api/contacts) who is the requester for the trip

salesperson

Staff member (/api/staff) that is assigned as the salesperson for the trip

itinerary

List of active Flight Legs (/api/flightlegs) that are scheduled for this trip

quotes

Optional

Quote (/api/quotes), if any, for this trip. A scheduled trip can have only a single quote

reports

Optional

Pilot and passenger tripsheets (/api/reports)for this trip

Relationships For a Flight Leg

trip

Trip (/api/trips) to which this flight leg belongs

lift

Aircraft, aircraft type or category (/api/lift) assigned to fly this flight leg

crew

Optional

Assigned crew members (/api/crewassignments) for this flight leg

reports

Optional

Pilot and passenger tripsheets (/api/reports)for this flight leg

Quoted Trips

In Schedaero, a quoted trip is a request from a specific contact to fly one or more requested flights. Each quoted trip contains one or more quotes, estimates of the price and flown itinerary on a specific aircraft

Relationships For Quoted Trips

requester

Contact (/api/contacts) who is the requester for the trip

salesperson

Staff member (/api/staff) that is assigned as the salesperson for the trip

quotes

One or more quotes (/api/quotes) for the requested itinerary

requestedItinerary

One or more request legs for the trip. Request legs are typically the passenger segments of the trip, and do not contain flight times because the aircraft is not yet known

Relationships For Quotes

trip

Trip (/api/trips) to which this flight leg belongs

itinerary

One or more quote legs for the trip on a specific aircraft, aircraft type or aircraft category. Quote legs include the trip’s request legs as well as any required position flights. Since the quote is for a specific aircraft, quote legs have flight times


Did this page help you?