Airline Routes

openapi: 3.0.0
info:
  title: Airline Routes
  version: 1.1.1
  description: Before using the API you will need to get an access token. Please read our **[Authorization Guide](https://developers.amadeus.com/self-service/apis-docs/guides/authorization)** for more information on how to get your token.
servers:
  - url: https://test.api.amadeus.com/v1
paths:
  /airline/destinations:
    get:
      summary: Amadeus Get Airline Destinations
      tags:
        - destinations
      responses:
        '200':
          description: Success Response
          content:
            application/vnd.amadeus+json:
              schema:
                $ref: '#/components/schemas/response_airlineRoutes'
              examples:
                Successful Reply:
                  value:
                    meta:
                      count: 3
                      links:
                        self: https:/test.api.amadeus.com/v1/airline/destinations?airlineCode=AF&max=3&arrivalCountryCode=FR
                    data:
                      - type: location
                        subtype: city
                        name: PARIS
                        iataCode: PAR
                        geoCode:
                          latitude: 48.85334
                          longitude: 2.34889
                        address:
                          cityName: PARIS
                          countryName: FRANCE
                          stateCode: FR-75
                          regionCode: EUROP
                        timeZone:
                          offset: '+02:00'
                          referenceLocalDateTime: '2022-10-25T10:17:00'
                        metrics:
                          relevance: 100
                      - type: location
                        subtype: city
                        name: NICE
                        iataCode: NCE
                        geoCode:
                          latitude: 43.66272
                          longitude: 7.20787
                        address:
                          cityName: NICE
                          countryName: FRANCE
                          stateCode: FR-06
                          regionCode: EUROP
                        timeZone:
                          offset: '+02:00'
                          referenceLocalDateTime: '2022-10-25T10:17:00'
                        metrics:
                          relevance: 12
                      - type: location
                        subtype: city
                        name: MARSEILLE
                        iataCode: MRS
                        geoCode:
                          latitude: 43.43556
                          longitude: 5.21361
                        address:
                          cityName: MARSEILLE
                          countryName: FRANCE
                          stateCode: FR-06
                          regionCode: EUROP
                        timeZone:
                          offset: '+02:00'
                          referenceLocalDateTime: '2022-10-25T10:17:00'
                        metrics:
                          relevance: 9
        '400':
          description: |-
            Bad Request

            code    | title                                 
            ------- | ------------------------------------- 
            572     | INVALID OPTION                         
            32171   | MANDATORY DATA MISSING 
            477     | INVALID FORMAT
            4926    | INVALID DATA RECEIVED              
            2781    | INVALID LENGTH                 
          content:
            application/vnd.amadeus+json:
              schema:
                $ref: '#/components/schemas/response_error'
              examples:
                example-error 400:
                  value:
                    errors:
                      - status: 400
                        code: 32171
                        title: MANDATORY DATA MISSING
                        detail: Missing mandatory query parameter 'airlineCode
        '500':
          description: |-
            Internal Server Error

            code    | title                                 
            ------- | ------------------------------------- 
            141     | SYSTEM ERROR HAS OCCURRED
          content:
            application/vnd.amadeus+json:
              schema:
                $ref: '#/components/schemas/response_error'
              examples:
                example-error 500:
                  value:
                    errors:
                      - status: 500
                        code: 141
                        title: SYSTEM ERROR HAS OCCURRED
      operationId: airline/destinations
      parameters:
        - schema:
            type: string
          in: query
          name: airlineCode
          description: Airline code following [IATA standard](http://www.iata.org/publications/Pages/code-search.aspx)
          required: true
          example: BA
        - schema:
            type: integer
          in: query
          name: max
          description: Maximum number of destinations in the response.
          example: 1
        - schema:
            type: string
          in: query
          name: arrivalCountryCode
          description: Arrival country code following [IATA standard](http://www.iata.org/publications/Pages/code-search.aspx), to filter the list of destinations
          example: FR
      description: ''
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    locations:
      title: destination
      type: object
      description: Description of a particular point or place in physical space
      properties:
        type:
          type: string
          description: type of API result "location"
          example: string-value
        subtype:
          type: string
          description: Location sub-type (e.g. airport, port, rail-station, restaurant, atm...)
          example: string-value
        name:
          type: string
          description: Label associated to the location (e.g. Eiffel Tower, Madison Square)
          example: '"Eiffel Tower"'
        iataCode:
          type: string
          description: IATA location code
          example: '"PAR"'
        geoCode:
          type: object
          description: Geographic coordinates describing the position of any location on the surface of Earth
          properties:
            latitude:
              type: number
              description: Latitude of the position expressed in decimal degrees (WSG 84), e.g. 6.244203. A positive value denotes northern hemisphere or the equator, and a negative value denotes southern hemisphere. The number of digits to represent the precision of the coordinate.
              example: '48.85837'
            longitude:
              type: number
              description: Longitude of the position expressed in decimal degrees (WSG 84), e.g. -75.581211. A positive value denotes east longitude or the prime meridian, and a negative value denotes west longitude. The number of digits to represent the precision of the coordinate.
              example: '2.294481'
        address:
          type: object
          properties:
            countryName:
              type: string
              description: Name of the country of the location
              example: France
            countryCode:
              type: string
              description: Code of the country of the location in ISO standard
              example: FR
            stateCode:
              type: string
              description: Code of the state of the location (if any)
              example: FR-13
            regionCode:
              type: string
              description: Code of the region of the location in ISO standard
              example: EUROP
        timeZone:
          type: object
          properties:
            offSet:
              type: string
              description: '''Total offset from UTC including the Daylight Saving Time (DST) following ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601) standard'''
              example: '+01:00'
            referenceLocalDateTime:
              type: string
              description: Date and time used as reference to determine the time zone name, code, offset, and dstOffset following ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601) standard.
              example: '2022-09-28T19:20:30'
        metrics:
          type: object
          properties:
            relevance:
              type: integer
              description: Score value based on the number of travelers per year and per destination. Score is between 0 and 100, 100 being the value for the destination city with the highest value of travelers for the origin airport
              example: '100'
    meta:
      title: meta
      type: object
      description: Meta information about the returned object(s) in "data"
      properties:
        count:
          type: integer
          description: Total number of object(s) retrieved
          format: int64
          example: 1
        links:
          type: object
          description: Links related to the returned object(s)
          properties:
            self:
              type: string
              description: Link to the same page.
              format: uri
              example: https://example.com/resource
    warnings:
      title: warning
      type: object
      properties:
        code:
          type: integer
          description: A machine-readable error code from the Canned Messages table, that will enable the API Consumers code to handle this type of error
          example: 1
        title:
          type: string
          description: An error title from the Canned Messages table with a 1:1 correspondence to the error code. This may be localized
          example: string-value
        detail:
          type: string
          description: An easy-to-read explanation specific to this occurrence of the problem. It should give the API consumer an idea of what went wrong and how to recover from it. Like the title, this field’s value can be localized.
          example: string-value
        source:
          type: object
          description: The Warning Source Definition
          properties:
            parameter:
              type: string
              description: The key of the URI path or query parameter that caused the error
              example: string-value
            pointer:
              type: string
              description: A JSON Pointer RFC6901 to the associated entity in the request body that caused this error
              example: string-value
            example:
              type: string
              description: A sample input to guide the user when resolving this issue
              example: string-value
    errors:
      title: Error
      properties:
        status:
          type: integer
          description: The [HTTP status code](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) of this response. This is present only in terminal errors which cause an unsuccessful response. In the case of multiple errors, they must all have the same status.
          example: 1
        code:
          type: integer
          description: A machine-readable error code from the Amadeus Canned Messages table, that will enable the API Consumers code to handle this type of error
          example: 1
        title:
          type: string
          description: An error title from the Canned Messages table with a 1:1 correspondence to the error code. This may be localized
          example: string-value
        detail:
          type: string
          description: An easy-to-read explanation specific to this occurrence of the problem. It should give the API consumer an idea of what went wrong and how to recover from it. Like the title, this field’s value can be localized.
          example: string-value
        source:
          type: object
          title: Error_Source
          properties:
            parameter:
              type: string
              description: The key of the URI path or query parameter that caused the error
              example: string-value
            pointer:
              type: string
              description: A JSON Pointer [RFC6901] to the associated entity in the request body that caused this error
              example: string-value
            example:
              type: string
              description: A sample input to guide the user when resolving this issue
              example: string-value
    response_error:
      type: object
      title: Error Reply
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/errors'
    response_airlineRoutes:
      type: object
      title: Airline Routes Reply
      properties:
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/warnings'
        data:
          type: array
          items:
            $ref: '#/components/schemas/locations'
        meta:
          $ref: '#/components/schemas/meta'