3. Get trip kit PDF

This API lets you know if the trip kit PDF is ready. If so, the URL to the PDF is provided. Generating the trip kit generally takes 20 to 30 seconds to complete.

Note: Jeppesen recommends that this API be invoked at least 5 seconds after the first POST request.
Service name Get trip kit PDF
Address format GET

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

Parameter type: Path

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

tripkit_id

Parameter type: Path

This parameter identifies the trip kit.
Supported HTTP method GET
GET request The request must include these HTTP headers:
  • User-Agent: The identification of the software acting for the user, in this format: company-product/1.0
  • Authorization: The access token returned in the authentication API call in this format: "Bearer ACCESS_TOKEN"
GET response The GET response is in HTTP 200.

GET response details

If the trip kit is generated, the GET response (HTTP 200) provides the storage location for the trip kit PDF, in JSON format. The response includes:
  • The URL of the trip kit PDF.
  • A list of server warning messages related to the request, if any.
{
  url" : "http://tripkit-test4-blue-jeppesen.com.s3-us-west-2.amazonaws.net/27JHN-CUCNP/
  KDEN-KLAX--2018-08-10.pdf?X-Amz-Security-Token=2BPgW5UIZ7YtMw2Nk2QUUOp&X-Amz-Algorithm=AWS4-
  HMAC-SHA256&X-Amz-Date=20180810T211547Z&X-Amz-SignedHeaders=host&X-Amz-Expires=28800&X-Amz-
  Credential=ASIAW43KPR7EO3DNIJO4%2F20180810%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=
  9760c737c4b39a7f527e62",
    "messages" : [
      {
        "code" : "205",
        "type" : "Warning",
        "message" : "One or more route points had multiple matches. Closest route points 
were selected"
      }
    ]
}

If the trip kit is not generated, the GET response (HTTP 202) contains more information, in JSON format:

{
    "messages": [
        {
            "code": "202",
            "type": "Info",
            "message": "Info: Requested trip kit is being generated."
        }
    ]
}

The response message might include one of four error message codes.

Error code Description
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 warning or error message
  • Message that describes the error
{
  "messages" : [
    {
      "code" : "201",
      "type" : "Error”,
      "message" : "Origin ICAO ABC is not in your coverage XYZ. Trip Kit 
cannot be generated."
      },
      {
        "code" : "203",
        "type" : "Error",
        "message" : "Alternate ICAO AC is not in your coverage XYZ. Trip
Kit cannot be generated."
        }
    ]
  }
401 (Unauthorized) The token is missing, invalid, or expired.
404 (Not Found) The resource is not found. The body contains the details of the error message:
  • Error code
  • Type of warning or error message
  • Message that describes the error
{
  "messages" : [
    {
      "code" : "301",
      "type" : "Error”,
      "message" : "Authentication Fail
    }
  ]
}
HTTP 5XX (Server Error) The server encountered errors when processing the request.