Amadeus Traveler Media Retrieve API

The Retrieve API from Amadeus Traveler Media — 1 operation(s) for retrieve.

OpenAPI Specification

amadeus-traveler-media-retrieve-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  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. \n\nPlease also be aware that our test environment is based on a subset of the production, this API in test only offers 24 hotels; 10 in London and 14 in New-York. You can find the list in our **[data collection](https://github.com/amadeus4dev/data-collection)**.\n"
  version: 1.0.2
  title: Hotel Ratings category-rated-areas Retrieve API
host: test.api.amadeus.com
basePath: /v2
schemes:
- https
produces:
- application/vnd.amadeus+json
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: ''
definitions:
  Issue:
    properties:
      status:
        description: the HTTP status code applicable to this error
        type: integer
      code:
        description: an application-specific error code
        type: integer
        format: int64
      title:
        description: a short summary of the error
        type: string
      detail:
        description: explanation of the error
        type: string
      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
          parameter:
            description: a string indicating which URI query parameter caused the issue
            type: string
          example:
            description: a string indicating an example of the right value
            type: string
  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
  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
  Error_500:
    properties:
      errors:
        type: array
        items:
          $ref: '#/definitions/Issue'
    required:
    - errors
    example:
      errors:
      - status: 500
        code: 141
        title: SYSTEM ERROR HAS OCCURRED
  Location:
    properties:
      id:
        description: id of the ressource
        type: string
      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
  Links:
    properties:
      href:
        type: string
        format: uri
      methods:
        type: array
        items:
          type: string
          enum:
          - GET
          - PUT
          - DELETE
          - POST
          - PATCH
    example:
      href: string
  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_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
parameters:
  poisId:
    name: poisId
    description: identifier of the pois
    required: true
    in: path
    type: string
    x-example: 9CB40CB5D0
responses:
  '404':
    description: Not Found
    schema:
      $ref: '#/definitions/Error_404'
  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
  '500':
    description: Unexpected Error
    schema:
      $ref: '#/definitions/Error_500'
  '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'