Amadeus · Schema

Prediction

Prediction schema from Trip Purpose Prediction

TravelTravel TechnologyReservationsFlightsHotelsAirlinesHospitalityTours and ActivitiesCars and TransfersDestination ContentItinerary ManagementTrip PlanningArtificial IntelligenceMarket Insights

Properties

Name Type Description
data object
meta object
View JSON Schema on GitHub

JSON Schema

trip-purpose-prediction-prediction-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/trip-purpose-prediction-prediction-schema.json",
  "title": "Prediction",
  "description": "Prediction schema from Trip Purpose Prediction",
  "type": "object",
  "properties": {
    "data": {
      "properties": {
        "type": {
          "description": "the resource name (`prediction`)",
          "type": "string",
          "example": "string-value"
        },
        "subType": {
          "type": "string",
          "example": "trip-purpose"
        },
        "id": {
          "description": "item identifier",
          "type": "string",
          "readOnly": true,
          "example": "12345"
        },
        "result": {
          "description": "forecast description",
          "type": "string",
          "enum": [
            "BUSINESS",
            "LEISURE"
          ],
          "example": "BUSINESS"
        },
        "probability": {
          "description": "probability of the forecast (between 0 and 1)",
          "type": "string",
          "example": "string-value"
        }
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "links": {
          "properties": {
            "self": {
              "type": "string",
              "format": "uri",
              "example": "https://example.com/resource"
            },
            "related": {
              "type": "string",
              "format": "uri",
              "example": "https://example.com/resource"
            },
            "type": {
              "type": "string",
              "example": "string-value"
            }
          }
        },
        "defaults": {
          "description": "the query parameters for which default values were used are returned here",
          "type": "object",
          "properties": {
            "searchDate": {
              "description": "the date on which the traveler is performing the search.",
              "type": "string",
              "example": "2019-06-11"
            }
          }
        }
      }
    }
  },
  "example": {
    "data": {
      "id": "NYCMAD20231201",
      "probability": "0.9995216",
      "result": "LEISURE",
      "subType": "trip-purpose",
      "type": "prediction"
    },
    "meta": {
      "defaults": {
        "searchDate": "2023-01-12"
      },
      "links": {
        "self": "https://test.api.amadeus.com/v1/travel/predictions/trip-purpose?originLocationCode=NYC&destinationLocationCode=MAD&departureDate=2023-12-01&returnDate=2023-12-12&searchDate=2023-01-12"
      }
    }
  }
}