openapi: 3.0.1
info:
  title: Airline Code Lookup air-traffic Retrieve API
  description: 'Before using this API, we recommend you read our

    **[Authorization Guide](https://developers.amadeus.com/self-service/apis-docs/guides/authorization-262)**

    for more information on how to generate an access token.


    Please also be aware that our test environment is based on a subset of the production,

    to see what is included in test please refer to our **[data collection](https://github.com/amadeus4dev/data-collection)**.

    '
  version: 1.2.1
  x-status: validated
  x-tags:
  - '#ama-for-dev'
  x-release-note:
    1.2.0:
    - Migration to OAS3
    1.1.0:
    - Correct example
    - Regroup parameter "IATACode" and "ICAOCode" under the same name "airlineCodes"
    1.0.0:
    - initial version
    - List all airlines information (name and code)
    - Introduction of search per IATA or ICAO code
servers:
- url: https://test.api.amadeus.com/v1
tags:
- name: Retrieve
paths:
  /reference-data/locations/pois/{poisId}:
    parameters:
    - $ref: '#/parameters/poisId'
    get:
      tags:
      - Retrieve
      operationId: getPointOfInterest
      summary: Amadeus Retieve One Point of Interest by its ID.
      responses:
        '200':
          $ref: '#/responses/point-of-interest'
        '400':
          $ref: '#/responses/400'
        '404':
          $ref: '#/responses/404'
        default:
          $ref: '#/responses/500'
      description: ''
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /safety/safety-rated-locations/{safety-rated-locationId}:
    parameters:
    - $ref: '#/parameters/safety-rated-locationId'
    get:
      tags:
      - Retrieve
      operationId: getLocationSafetyRanking
      deprecated: true
      summary: Amadeus Retieve Safety Information of a Location by its ID.
      responses:
        '200':
          $ref: '#/responses/safety-rated-location'
        '400':
          $ref: '#/responses/400'
        '404':
          $ref: '#/responses/404'
        default:
          $ref: '#/responses/500'
      description: ''
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /shopping/activities/{activityId}:
    parameters:
    - $ref: '#/parameters/activityId'
    get:
      tags:
      - Retrieve
      operationId: GETActivity
      summary: Amadeus Retrieve One Activity by its ID
      responses:
        '200':
          $ref: '#/responses/activity'
        '400':
          $ref: '#/responses/400_Retreive'
        '404':
          $ref: '#/responses/404'
        default:
          $ref: '#/responses/500'
      description: ''
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
definitions:
  SafetyRatedLocation:
    type: object
    title: SafetyRatedLocation
    allOf:
    - type: object
      properties:
        safetyScore:
          $ref: '#/definitions/SafetyScore'
    - $ref: '#/definitions/Location_2'
  Collection_Meta_2:
    type: object
    title: Collection_Meta
    properties:
      count:
        type: integer
        example: 1
      links:
        type: object
        title: CollectionLinks
        properties:
          self:
            type: string
            format: uri
            example: https://test.api.amadeus.com/v1/area/resources?...
          next:
            type: string
            format: uri
            example: https://test.api.amadeus.com/v1/area/resources?...
          previous:
            type: string
            format: uri
            example: https://test.api.amadeus.com/v1/area/resources?...
          last:
            type: string
            format: uri
            example: https://test.api.amadeus.com/v1/area/resources?...
          first:
            type: string
            format: uri
            example: https://test.api.amadeus.com/v1/area/resources?...
          up:
            type: string
            format: uri
            example: https://test.api.amadeus.com/v1/area/resources?...
        example:
          self: https://test.api.amadeus.com/v1/area/resources?param=value
  Activity:
    type: object
    title: Activity
    description: Activity description
    properties:
      type:
        type: string
        description: the ressource name
        readOnly: true
        example: string-value
      id:
        type: string
        description: unique id of the ressource
        readOnly: true
        example: '12345'
      self:
        $ref: '#/definitions/Link'
      name:
        type: string
        description: activity name
        example: Sample Name
      shortDescription:
        type: string
        description: short description of the activity
        example: Sample description text.
      description:
        type: string
        description: full description of the activity
        example: Sample description text.
      geoCode:
        $ref: '#/definitions/GeoCode_2'
      rating:
        type: string
        description: rating of the activity
        example: string-value
      price:
        $ref: '#/definitions/ElementaryPrice'
      pictures:
        type: array
        description: link to picture related to the activity
        items:
          type: string
      bookingLink:
        type: string
        description: url to book the activity
        example: string-value
      minimumDuration:
        type: string
        description: Minimum recommended duration for the activity
        example: PT2H30M
  GeoCode:
    properties:
      latitude:
        description: latitude of the location
        type: number
        format: double
        example: 43.580418
      longitude:
        description: longitude of the location
        type: number
        format: double
        example: 7.125102
  Issue:
    properties:
      status:
        description: the HTTP status code applicable to this error
        type: integer
        example: 1
      code:
        description: an application-specific error code
        type: integer
        format: int64
        example: 1
      title:
        description: a short summary of the error
        type: string
        example: string-value
      detail:
        description: explanation of the error
        type: string
        example: string-value
      source:
        type: object
        title: Issue_Source
        description: an object containing references to the source of the error
        maxProperties: 1
        properties:
          pointer:
            description: a JSON Pointer [RFC6901] to the associated entity in the request document
            type: string
            example: string-value
          parameter:
            description: a string indicating which URI query parameter caused the issue
            type: string
            example: string-value
          example:
            description: a string indicating an example of the right value
            type: string
            example: string-value
  GeoCode_2:
    type: object
    description: geo position
    properties:
      latitude:
        description: latitude of the location
        type: number
        format: double
        example: 43.580418
      longitude:
        description: longitude of the location
        type: number
        format: double
        example: 7.125102
  Issue_2:
    type: object
    properties:
      status:
        description: the HTTP status code applicable to this error
        type: integer
        example: 1
      code:
        description: an application-specific error code
        type: integer
        format: int64
        example: 1
      title:
        description: a short summary of the error
        type: string
        example: string-value
      detail:
        description: explanation of the error
        type: string
        example: string-value
      source:
        type: object
        title: Issue_Source
        description: an object containing references to the source of the error
        maxProperties: 1
        properties:
          pointer:
            description: a JSON Pointer [RFC6901] to the associated entity in the request document
            type: string
            example: string-value
          parameter:
            description: a string indicating which URI query parameter caused the issue
            type: string
            example: string-value
          example:
            description: a string indicating an example of the right value
            type: string
            example: string-value
  Collection_Meta:
    title: Collection_Meta
    properties:
      count:
        type: integer
        example: 1
      links:
        title: CollectionLinks
        properties:
          self:
            type: string
            format: uri
            example: https://test.api.amadeus.com/v1/area/resources?...
          next:
            type: string
            format: uri
            example: https://test.api.amadeus.com/v1/area/resources?...
          previous:
            type: string
            format: uri
            example: https://test.api.amadeus.com/v1/area/resources?...
          last:
            type: string
            format: uri
            example: https://test.api.amadeus.com/v1/area/resources?...
          first:
            type: string
            format: uri
            example: https://test.api.amadeus.com/v1/area/resources?...
          up:
            type: string
            format: uri
            example: https://test.api.amadeus.com/v1/area/resources?...
        example:
          self: https://test.api.amadeus.com/v1/area/resources?param=value
  Links:
    properties:
      href:
        type: string
        format: uri
        example: https://example.com/resource
      methods:
        type: array
        items:
          type: string
          enum:
          - GET
          - PUT
          - DELETE
          - POST
          - PATCH
    example:
      href: string
  Location_2:
    properties:
      id:
        description: id of the ressource
        type: string
        example: '12345'
      self:
        $ref: '#/definitions/Links_2'
      type:
        description: the resource name
        type: string
        example: location
      subType:
        description: location sub type
        type: string
        enum:
        - AIRPORT
        - CITY
        - POINT_OF_INTEREST
        - DISTRICT
        example: AIRPORT
      name:
        description: short name of the location
        type: string
        example: Paris CDG
      geoCode:
        $ref: '#/definitions/GeoCode'
  ElementaryPrice:
    description: elementaryPrice
    type: object
    properties:
      amount:
        type: string
        description: Amount of the fare. could be alpha numeric. Ex- 500.20 or 514.13A, 'A'signifies additional collection.
        example: '199.50'
      currencyCode:
        type: string
        description: Currency type of the fare.
        example: EUR
  Location:
    properties:
      id:
        description: id of the ressource
        type: string
        example: '12345'
      self:
        $ref: '#/definitions/Links'
      type:
        description: the resource name
        type: string
        example: location
      subType:
        description: location sub type
        type: string
        enum:
        - AIRPORT
        - CITY
        - POINT_OF_INTEREST
        - DISTRICT
        example: AIRPORT
      name:
        description: short name of the location
        type: string
        example: Paris CDG
      geoCode:
        $ref: '#/definitions/GeoCode'
      category:
        description: category of the location
        type: string
        enum:
        - SIGHTS
        - BEACH_PARK
        - HISTORICAL
        - NIGHTLIFE
        - RESTAURANT
        - SHOPPING
        example: HISTORICAL
      tags:
        description: list of tags related to the location
        type: array
        items:
          type: string
          example:
          - grocery
          - japanese
          - cafe
      rank:
        description: the rank is the position compared to other locations based on how famous is a place. 1 being the highest.
        type: string
        example: 1
  Error_400_2:
    type: object
    properties:
      errors:
        type: array
        items:
          $ref: '#/definitions/Issue_2'
    required:
    - errors
    example:
      errors:
      - status: 400
        code: 477
        title: INVALID FORMAT
        detail: invalid query parameter format
        source:
          parameter: airport
          example: CDG
  Link:
    type: object
    properties:
      href:
        type: string
        format: uri
        example: https://example.com/resource
      methods:
        type: array
        items:
          type: string
          enum:
          - GET
          - PUT
          - DELETE
          - POST
          - PATCH
    example:
      href: string
  SafetyScore:
    properties:
      women:
        description: Likelihood of inappropriate behavior against females. Score go from 1 (not likely) to 100 (very likely).
        type: integer
        example: 1
      physicalHarm:
        description: Likelihood of injury due to harmful intent. Score go from 1 (not likely) to 100 (very likely).
        type: integer
        example: 1
      theft:
        description: Likelihood of theft. Score go from 1 (not likely) to 100 (very likely).
        type: integer
        example: 1
      politicalFreedom:
        description: Potential for infringement of political rights or political unrest. Score go from 1 (not likely) to 100 (very likely).
        type: integer
        example: 1
      lgbtq:
        description: Likelihood of harm or discrimination against LGBTQ persons or groups and level of caution required at location. Score go from 1 (not likely) to 100 (very likely).
        type: integer
        example: 1
      medical:
        description: Likelihood of illness or disease, assessment of water and air quality, and access to reliable medical care. Score go from 1 (not likely) to 100 (very likely).
        type: integer
        example: 1
      overall:
        description: An average of the 6 “sub”-categories. Score go from 1 (very safe) to 100 (very dangerous).
        type: integer
        example: 1
  Error_400:
    properties:
      errors:
        type: array
        items:
          $ref: '#/definitions/Issue'
    required:
    - errors
    example:
      errors:
      - status: 400
        code: 477
        title: INVALID FORMAT
        detail: invalid query parameter format
        source:
          parameter: airport
          example: CDG
  Error_500:
    properties:
      errors:
        type: array
        items:
          $ref: '#/definitions/Issue'
    required:
    - errors
    example:
      errors:
      - status: 500
        code: 141
        title: SYSTEM ERROR HAS OCCURRED
  Error_404:
    properties:
      errors:
        type: array
        items:
          $ref: '#/definitions/Issue'
    required:
    - errors
    example:
      errors:
      - status: 404
        code: 1797
        title: NOT FOUND
        detail: no response found for this query parameter
        source:
          parameter: airport
  Links_2:
    required:
    - href
    properties:
      href:
        type: string
        format: uri
        example: https://example.com/resource
      methods:
        type: array
        items:
          type: string
          enum:
          - GET
          - PUT
          - DELETE
          - POST
          - PATCH
      count:
        type: integer
        example: 1
    example:
      href: string
parameters:
  safety-rated-locationId:
    name: safety-rated-locationId
    description: identifier of the location
    required: true
    in: path
    type: string
    x-example: Q930402719
  poisId:
    name: poisId
    description: identifier of the pois
    required: true
    in: path
    type: string
    x-example: 9CB40CB5D0
  activityId:
    name: activityId
    required: true
    in: path
    type: string
    x-example: '23642'
responses:
  safety-rated-location:
    description: Successful Operation
    schema:
      title: Success
      required:
      - data
      properties:
        warnings:
          type: array
          items:
            $ref: '#/definitions/Issue'
        meta:
          $ref: '#/definitions/Collection_Meta'
        data:
          $ref: '#/definitions/SafetyRatedLocation'
      example:
        meta:
          links:
            self: https://test.api.amadeus.com/v1/safety/safety-rated-locations/Q930402719
        data:
        - type: safety-rated-location
          id: Q930402719
          self:
            type: https://test.api.amadeus.com/v1/safety/safety-rated-locations/Q930402719
            methods:
            - GET
          subType: CITY
          name: Barcelona
          geoCode:
            latitude: 41.385064
            longitude: 2.173404
          safetyScores:
            lgbtq: 39
            medical: 0
            overall: 45
            physicalHarm: 36
            politicalFreedom: 50
            theft: 44
            women: 34
  '404':
    description: Not Found
    schema:
      $ref: '#/definitions/Error_404'
  '500':
    description: Unexpected Error
    schema:
      $ref: '#/definitions/Error_500'
  activity:
    description: Successful Operation
    schema:
      title: Successful Search
      required:
      - data
      properties:
        meta:
          $ref: '#/definitions/Collection_Meta_2'
        warnings:
          type: array
          items:
            $ref: '#/definitions/Issue_2'
        data:
          $ref: '#/definitions/Activity'
      example:
        meta:
          self: https://test.api.amadeus.com/v1/shopping/activities/23642
        data:
          id: '23642'
          type: activity
          self:
            href: https://test.api.amadeus.com/v1/shopping/activities/23642
            methods:
            - GET
          name: Skip-the-line tickets to the Prado Museum
          shortDescription: Book your tickets for the Prado Museum in Madrid, discover masterpieces by Velázquez, Goya, Mantegna, Raphael, Tintoretto and access all temporary exhibitions.
          geoCode:
            latitude: '40.414000'
            longitude: '-3.691000'
          rating: '4.500000'
          pictures:
          - https://images.musement.com/cover/0001/07/prado-museum-tickets_header-6456.jpeg?w=500
          bookingLink: https://b2c.mla.cloud/c/QCejqyor?c=2WxbgL36
          price:
            currencyCode: EUR
            amount: '16.00'
  '400':
    description: "code    | title                                 \n------- | ------------------------------------- \n477     | INVALID FORMAT\n572     | INVALID OPTION\n4926    | INVALID DATA RECEIVED               \n32171   | MANDATORY DATA MISSING \t     \n"
    schema:
      $ref: '#/definitions/Error_400'
  point-of-interest:
    description: Successful Operation
    schema:
      title: Success
      required:
      - data
      properties:
        meta:
          $ref: '#/definitions/Collection_Meta'
        data:
          $ref: '#/definitions/Location'
      example:
        data:
          type: location
          subType: POINT_OF_INTEREST
          id: 9CB40CB5D0
          self:
            href: https://test.api.amadeus.com/v1/reference-data/locations/pois/9CB40CB5D0
            methods:
            - GET
          geoCode:
            latitude: 41.39165
            longitude: 2.164772
          name: Casa Batlló
          category: SIGHTS
          rank: 1
          tags:
          - sightseeing
          - sights
          - museum
          - landmark
          - tourguide
          - restaurant
          - attraction
          - activities
          - commercialplace
          - shopping
          - souvenir
  400_Retreive:
    description: "Code   | Title\n-------|----------------\n572    | INVALID OPTION\t     \n"
    schema:
      $ref: '#/definitions/Error_400_2'