2. Request a trip kit

This API receives a request to create a trip kit.

Service name Request to create a new trip kit
Address format POST

Evaluation: https://tripkit-api.tripkit-eval.jeppesen.com/v1/companies/{company_code}/tripkits

Production: https://tripkit-api.jeppesen.com/v1/companies/{company_code}/tripkits

Parameters company_code

Parameter type: Path

During onboarding, Jeppesen provides this parameter, which is unique to each airline.

Supported HTTP method POST
POST request The request must include these HTTP headers:
  • Content-Type: application/json
  • User-Agent: Identification of the software acting for the user, in this format: ompany-product/1.0
  • Authorization: The access token that is returned in the authentication API call in the format Bearer ACCESS_TOKEN

For the details that are required in this request, see POST request details.

POST response The response code is in HTTP 202. This response includes this HTTP header:

Content-Type: application/json

For the details, see POST response details.

POST request details

The body of the POST request contains the following parameters in JSON format. If the service encounters a problem processing the request, an error is returned.
Parameter Description Type
company The company name, for example, Atlantis Airlines. Jeppesen provides this parameter during onboarding. String
origin The ICAO code of origin airport, for example, KDEN.

If this parameter is empty, an HTTP Code 400 error is returned with the message Error: Origin was not provided. No trip kit generated.

If this origin airport is not in your coverage area, the request is accepted. However, when the Download Trip Kit API call is made, you receive the error message Error: Origin is not in coverage. No trip kit generated.
String
destination The ICAO code for the destination airport, for example, KIAH.

If this parameter is empty, an HTTP Code 400 error is returned with the message Error: Destination was not provided. No trip kit generated.

If this destination airport is not in your coverage area, the request is accepted. However, when the Download Trip Kit API call is made, you receive the error message Error: Destination is not in coverage. No trip kit generated.

String
route The route string of the flight, using space or dot notation, as in this example:

WEEDS DUUCE GCK CVE CHMPZ TORNN REFYN OILLL DPLAN SSTAX MPORT GUSHR

If no route string in included, this parameter is empty.

If the format is invalid, an HTTP Code 400 is returned with the message Error: Route String contains characters that are not allowed. Use only UTF-8 alphanumeric ( a-z, A-Z, or 0-9 ), hyphen ( - ), dot ( . ), slash ( / ), space ( ) or underscore ( _ ). No Trip Kit generated.

If the route contains ambiguous points, Trip Kit automatically selects a valid match. When the Download Trip Kit API call is made, you receive the message Warning: One or more route points had multiple valid matches. The match closest to route of flight was used in the generated trip kit.

If the route contains an invalid route point, the request is still accepted. However, when the Download Trip Kit API call is made, you receive the error message Error: The following route points are invalid against the current enroute cycle: {0}. No trip kit generated.
String
alternates The list of alternate airports, for example CKOS, KMCI. You can include up to 15 alternate airports. If this parameter is empty, no alternate airports are specified.

If you provide more than 15 alternate airports, an HTTP Code 400 is returned with the message Error: Maximum number of alternates has been exceeded. No trip kit generated.

If your coverage area does not include at least one alternate airport, the request is still accepted. However, when the Download Trip Kit call is made, you receive the error message Error: One or multiple alternates are not in coverage. No trip kit generated.
String
fleet The fleet code, for example, B737.

If this parameter matches a fleet in your company's tailored enroute data, this data is included in the trip kit.

If this parameter is empty, the Jeppesen standard enroute data is used, and you receive the message Warning: Fleet value was not provided. If your company has tailored enroute content, only non-fleet-specific tailored Enroute data is included in the generated Trip Kit.

If this parameter does not match a fleet in your company's tailored enroute data, the Jeppesen standard enroute data is used, and you receive the message Warning: Fleet value does not match tailored enroute fleets. If your company has tailored enroute content, only non-fleet-specific data are included in the generated trip kit.
String
flight_number The flight number, for example, AAL145.

If the flight number is invalid, the request is rejected. An HTTP Code 400 is returned with the message Error: flight_number value is in unsupported format. No trip kit generated.

String
flight_plan_id The flight plan identification code, for example, 002915. String
departure_date The date of departure and the time in Zulu, for example, 2018-08-10T14:22:30.345Z. This parameter follows this format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

If this parameter is empty, or if the format is invalid, the request is rejected. An HTTP Code 400 is returned with the message Error: departure_date value is in invalid format. No trip kit generated.

String
flight_identifier The flight identifier, for example, AF18. String
coverage The coverage code for the terminal charts, for example, EJEP02.

If this parameter is empty, the request is still accepted. The Jeppesen Worldwide Coverage (EJEP02) is used, and this message is returned: Warning: Terminal charts coverage value was not provided. Jeppesen Standard Worldwide Coverage was used in the generated trip kit..

If this value does not match any terminal chart coverage mapped within the trip coverage mapping service, the request is rejected. The HTTP Code 400 is returned with the message Error: Terminal charts coverage value does not match coverages available for use within trip kit. No trip kit generated.
String
enroute_options A configuration in JSON format that describes how the enroute chart is displayed in the trip kit. If this parameter is present, the enroute chart is included in the trip kit. This parameter contains the following configuration information: JSON
include_enroute Indicates whether the enroute chart is included in the trip kit. If this value is invalid, the request is rejected. An HTTP Code 400 is returned with the message Error: include_enroute value is in invalid format. No trip kit generated. Boolean (true, false)
chart_type The configuration for the enroute chart type. Four options are possible:
  • 10NM_HIFR: 10 nautical miles per inch in High IFR
  • 10NM_LIFR: 10 nautical miles per inch in Low IFR
  • 20NM_HIFR: 20 nautical miles per inch in High IFR
  • 20NM_LIFR: 20 nautical miles per inch in Low IFR
String
include_com_freqs Indicates whether FIR/UIR communication frequency pages are included in the trip kit. If this value is invalid, the request is rejected. An HTTP Code 400 error is returned with the message Error: include_com_freqs value is in invalid format. No trip kit generated. Boolean (true, false)
include_ref_note_pages Indicates whether the enroute reference notes pages are included in the trip kit. If this value is invalid, the request is rejected. An HTTP Code 400 error is returned with the message Error: include_ref_note_pages value is in invalid format. No trip kit generated. Boolean (true, false)
include_strip_charts Indicates whether strip charts are included in the trip kit. If this value is invalid, the request is rejected. An HTTP Code 400 is returned with the message Error: include_strip_charts value is in invalid format. No trip kit generated. Boolean (true, false)
use_auto_disambiguation Indicates whether ambiguous objects are solved automatically. If invalid, the trip kit request is rejected when a route object is not found in the database. An HTTP Code 400 is returned with the message Error: user_auto_disambiguation value is in invalid format. No Trip Kit generated.

If set to true, internal logic is used to select the most appropriate element when the route includes an ambiguous or duplicate object. A trip kit is generated.

Boolean (true, false)
remove_not_found_route_elements Instructs Trip Kit to remove route elements that it does not find. When set to true, invalid or unrecognized navigation elements (including text strings, waypoints, navaids, and airways) are removed. A trip kit is generated even though these invalid or unrecognized elements are removed.
Warning: As stipulated in your contract supplement, you agree to accept full responsibility for this action and to have a process by which to validate the navigation elements before you use the generated trip kit. Jeppesen is not responsible for the removal of any invalid or unrecognized navigation elements that you initiated through this parameter.

When set to false or when invalid, the trip kit request is rejected if a navigation element is invalid. HTTP code 400 is returned with the message Error: remove not found route elements value is in valid format. No Trip Kit generated.

Boolean (true, false)
termchart_options A configuration in JSON format that describes how terminal charts are displayed in the trip kit. This configuration contains the following information: JSON
include_termchart Indicates whether terminal charts are included in the trip kit. If this value is invalid, the request is rejected. An HTTP Code 400 error is returned with the message Error: include_termchart value is in invalid format. No trip kit generated.

If this value is set to false, the include_destination_alternate_sid and include_origin_star_app configurations are not used.

Boolean (true, false)
include_destination_alternate_sid Indicates whether departure charts at the destination and alternate airports are included in the trip kit. If this value is invalid, the request is rejected. An HTTP Code 400 error is returned with the message Error: include_destination_alternate_sid value is in invalid format. No trip kit generated. Boolean (true, false)
include_origin_star_app Indicates whether the arrival and approach charts at the origin airport are included in the trip kit. If this value is invalid, the request is rejected. An HTTP Code 400 error is returned with the message Error: include_origin_star_app value is in invalid format. No trip kit generated. Boolean (true, false)

Example of a POST request

{
  "company" : "Atlantis Airlines",
  "origin" : "KDEN",
  "destination" : "KIAH",
  "route" : "WEEDS DUUCE GCK CVE CHMPZ TORNN REFYN OILLL DPLAN SSTAX MPORT GUSHR",
  "alternates" : ["KCOS", "KMCI"],
  "flight_number" : "AAL145",
  "fleet" : "B737",
  "flight_plan_id" : "123456",
  "departure_date" : "2018-08-10T14:22:30.345Z",
  "flight_identifier" : "B737",
  "coverage" : "EJEP02",
  "termchart_options" : {
    "include_termchart" : true,
    "include_origin_star_app" : true,
    "include_destination_alternate_sid" : true
    "use_auto_disambiguation" : false
    "remove_not_found_route_elements" : false
  },
  "enroute_options" : {
    "include_enroute" : true,
    "chart_type" : "10NM_HIFR",
    "include_com_freqs" : true,
    "include_ref_note_pages" : true,
    "include_strip_charts" : true
  }
}

POST response details

The POST response provides download information, in JSON format, for the PDF and URL. The response includes:
  • The URL for getting the trip kit PDF file.
  • A list of server warning messages related to the request, if any.
{
"pdf" : "https://tripkit-api.tripkit-eval.jeppesen.com/companies/{company_code}
/tripkits/c556cf61-68fc-49f5-9ea3-546bcff15615/pdf",
  "messages" : [
    {
        "code" : "150",
        "type" : "Warning”,
        "message" : "Fleet value was not provided. Only non-fleet-specific 
    tailored Enroute data is included."
    },
    {
        "code" : "152",
        "type" : "Warning",
        "message" : "Coverage value was not provided. Trip Kit was generated 
     for standard Worldwide coverage."
    }
    ]
}

The response message might include one of four error codes.

Error Code Description
HTTP 400 (Bad Request) The input is invalid or is missing required parameters. See the body of the response for the details. The body contains the details of the error message:
  • Error code
  • Type of of warning or error message
  • Message that describes the error
{
  "messages" : [
    {
      "code" : "101",
      "type" : "Error”,
      "message" : "Origin ICAO value was not provided. Trip Kit cannot be generated."
      },
      {
        "code" : "103",
        "type" : "Error",
        "message" : "Maximum number of Alternate ICAOs has been exceeded. 
Trip Kit cannot be generated."
        }
    ]
  }
HTTP 401 (Unauthorized) The token is missing, invalid, or expired.
HTTP 404 (Not Found) The resource is not found. The body contains the details of the error message:
  • Error code
  • Type of of warning or error message
  • Message that describes the error
{
  "messages" : [
    {
      "code" : "301",
      "type" : "Error”,
      "message" : "Authentication Fail
    }
  ]
}
HTTP 5XX (server Error) Server errors were encountered when processing the request.