LogoLogo
  • OCTO Specification and Zaui
  • Glossary of Terms
  • Getting Started
  • Test Credentials
  • Headers
  • Errors
  • Rate Limits
  • Advanced Capabilities
  • FAQ's
  • Basic Capabilities
    • Supplier
    • Products
    • Availability
    • Booking
  • Advanced Capabilities (optional)
    • Content
    • Pricing
    • Pickups
    • GT-Locations
    • GT-Connections
    • Grouped-departures
Powered by GitBook
On this page

Was this helpful?

  1. Advanced Capabilities (optional)

Grouped-departures

This capability allows grouping of interval time slots

PreviousGT-Connections

Last updated 2 years ago

Was this helpful?

Add octo/grouped-departures to your OCTO-Capabilities header

Add it to both and calls, in order for it to work

Used with List , Single and endpoints. Groups interval time slots into Morning Departures (before noon), Afternoon Departures (noon till 6pm), Evening Departures (6pm till midnight).

Assigns unique id for different departure groups, which is used in request as optionId

Response

"options": [
        {
            "id": "ac0ff447450a0b3102db16cfaae7edc13729bf5b",
            "internalName": "Morning Departures",
            ...
        },
        {
            "id": "5e66a4a9f8cefa58c8403540463e9715a4771c16",
            "internalName": "Afternoon Departures",
            ...
        },
        {
            "id": "10921bf8a1bffb723bb08aa67192fae681549725",
            "internalName": "Evening Departures",
            ...
        }
    ],

optionId for particular departure group will return time slots associated with it

Response

Below is the response when Afternoon Departures id is passed as optionId in request

[
    {
        "id": "2022-09-25T12:00:00-07:00",
        "localDateTimeStart": "2022-09-25T12:00:00-07:00",
        "localDateTimeEnd": "2022-09-25T14:00:00-07:00",
        ...
    },
    {
        "id": "2022-09-25T13:00:00-07:00",
        "localDateTimeStart": "2022-09-25T13:00:00-07:00",
        "localDateTimeEnd": "2022-09-25T15:00:00-07:00",
        ...
    },
    {
        "id": "2022-09-25T14:00:00-07:00",
        "localDateTimeStart": "2022-09-25T14:00:00-07:00",
        "localDateTimeEnd": "2022-09-25T16:00:00-07:00",
       ...
    },
    {
        "id": "2022-09-25T15:00:00-07:00",
        "localDateTimeStart": "2022-09-25T15:00:00-07:00",
        "localDateTimeEnd": "2022-09-25T17:00:00-07:00",
        ...
    },
    {
        "id": "2022-09-25T16:00:00-07:00",
        "localDateTimeStart": "2022-09-25T16:00:00-07:00",
        "localDateTimeEnd": "2022-09-25T18:00:00-07:00",
        ...
    },
    {
        "id": "2022-09-25T17:00:00-07:00",
        "localDateTimeStart": "2022-09-25T17:00:00-07:00",
        "localDateTimeEnd": "2022-09-25T19:00:00-07:00",
        ...
    }
]

Assign unique id for different departure groups

Response

Below is the response when octo/grouped-departures is passed in the header

"options": [
        {
            "id": "ac0ff447450a0b3102db16cfaae7edc13729bf5b",
            "internalName": "Morning Departures",
            ...
        },
        {
            "id": "5e66a4a9f8cefa58c8403540463e9715a4771c16",
            "internalName": "Afternoon Departures",
            ...
        },
        {
            "id": "10921bf8a1bffb723bb08aa67192fae681549725",
            "internalName": "Evening Departures",
            ...
        }
    ],

optionId used and id received in request will be used in endpoint as payload. Further steps are same regardless of octo-capabilities header

Availability
Booking
Products
Availability
Availability
Availability
Products
Product