Skip to content

Available dates

This method allows us to obtain date availability for each activity available within the requested package.

Implications

Since a package can be made up of one or more activities, there may be access restrictions that prevent all activities from being carried out on the same day. This may be due to distance between them, the time required to perform each activity, or any other restriction or incompatibility that has been configured.

Therefore, this method must be called as many times as there are activities in the requested package.

In the first call, we will specify the package identifier (PackageId) and omit the date groupings (PaxGroupingsDates). The response will show a list with the availability of the different activities included in the package. This way, the customer can select the access date for the first activity. The first activity can be any of the activities shown in the response.

Once we have the information for the first activity and the date chosen by the customer, we will call this method again adding that first choice to PaxGroupingsDates. The response will show a list with the availability of the next activities included in the package, taking into account the possible restrictions introduced by the first choice and allowing the customer to choose that second activity and access date.

We will keep repeating this last action with the remaining activities.

{
    "EchoToken" : "x3cig4i6oq1dyqskapaeu8i8h6",
    "PackageId": "1jpb69xrh3usy"
}

{
    "EchoToken" : "x3cig4i6oq1dyqskapaeu8i8h6",
    "PackageId": "1jpb69xrh3usy",
    "PaxGroupingsDates" : [
        {
            "Id" : "mx3osekefh43g",
            "Date" : "2023-01-25"
        }
    ] 
}

{
    "EchoToken" : "x3cig4i6oq1dyqskapaeu8i8h6",
    "PackageId": "1jpb69xrh3usy",
    "PaxGroupingsDates" : [
        {
            "Id" : "mx3osekefh43g",
            "Date" : "2023-01-25"
        },
        {
            "Id" : "6oq1dyqskapae",
            "Date" : "2023-01-26"
        }
    ] 
}

Access method

POST /Package/AvailableDates

Request structure

  • EchoToken: (string). Required. Token that identifies the request sequence. See extended catalog.
  • PackageId: (string). Required. Package identifier. See property Packages.Package.Id in the extended catalog.
  • PaxGroupingsDates: (list). Optional. List of already selected groupings and dates.
    • PaxGroupingDates: (object). Optional. Grouping information.
      • Id: (string). Required. ProductPaxGroupingId grouping identifier.
      • Date: (date). Required. Activity access date.

Request examples

Example 
{
    "EchoToken" : "x3cig4i6oq1dyqskapaeu8i8h6",
    "PackageId": "1jpb69xrh3usy",
    "PaxGroupingsDates" : [
        {
            "Id" : "mx3osekefh43g",
            "Date" : "2023-01-25"
        },
        {
            "Id" : "6oq1dyqskapae",
            "Date" : "2023-01-26"
        }
    ] 
}

Response structure

  • PaxGroupingsDates: (list). List of groupings.

    • PaxGroupingDates: (object). Grouping information.
      • Id: (string). Grouping identifier (PaxGroupingId).
      • Dates: (list). List of available dates.
        • (date): Available date. ISO 8601 format (yyyy-MM-dd).

  • Success: (boolean). Value that indicates whether the call was processed correctly or not.

  • Errors: (list). Array of errors.
    • Error: (object).
      • ErrorMessage: (string). Error message explaining why the request was not successful. If it was correct, it will return null.
      • ErrorCode: (int). Code that identifies the error.
  • ErrorEntityBreakDown (list): list that contains objects with the name and ID in case of error.
    • Id (string): identifier
    • Name (string): related name of the identifier.

Response examples

Example 
{
    "PaxGroupingsDates": [
        {
            "Id": "4gazafx5sjcph",
            "Dates": [
                "2023-01-25T00:00:00",
                "2023-01-26T00:00:00",
                "2023-01-27T00:00:00",
                "2023-01-28T00:00:00"
            ]
        }
    ],
    "Success": true
}