Was this helpful?
The Itinerary Schema is a set of related items that can be used to compose a representation of lists, trips and trails.
When creating an itinerary, we can use different elements to represent the itinerary, and can use these elements as we transition between different types of content, such as a list that may contain some simple locations, through to trips and trails by introducing directions and routes.
The most primitive element of an itinerary is the ItineraryLocation. This creates an association to a place that exists in the physical world.
The place association can be a simple dropped location (such as a long/lat) position, but also can be an association to place information that exists.
The alpaca platform supports a wide range of extended cases for locations, including offering access instructions, arrival locations for routing and more.
Content can be attached to all elements of the itinerary in order to communicate specifics with your audience.
This can include common content such as:
Content can be attached to your itinerary or to the individual elements appearing within the itinerary.
Locations are commonly associated with places that with an ID. These are commonly sourced from various sources that refer to places that exist. Alpaca takes care of fetching and keeping this information up to date in accordance with the providers rate-limits and terms and conditions.
We refer to place data as being sourced from a Place Provider. Examples of a place provider that we support include open data providers such as OpenStreetMap, OpenAddresses, WOF, Geonames or commercial place providers, such as Facebook, ATDW etc.
When you query the place data, you will be returned with information about that place for you to build presentation screens, such as place contact information, addresses or opening hours.
Data attributes exist on itinerary items in order to store additional data against parts of your itinerary. Hundreds of defined data attributes exist against different types of elements, which contain structured values for things such as Place data (like cuisine types and more).
As you activate and utilise features such as automatic routing, you can start working with directions.
These directions can automatically appear in your itinerary if you use auto-routing features and will represent the route between locations. You can control the modes of transport and search for itinerary directions or manually create your own waypoints or paths between locations.
In addition to these elements, an Itinerary Location also can contain additional itinerary locations assigned to them. These can represent places of interest or sights and activities that can be undertaken by visitors.
This provides a hierarchical structuring where a location can encompass multiple options, which could represent plotting a town or city, and indicating a number of locations to do in this area.
Itinerary Locations can be marked as optional. This indicates that a location on the itinerary isn't necessarily part of the itinerary, but can be undertaken optionally. As such, the routing may not show it part of the itinerary.
Itineraries can be organised into collections and segments that can offer features such as segmenting a trail into different sections, representing suggested durations or distances, or even organised into seperate legs to represent different parts of a trip.
The itinerary structure does not stop there!
The above section is used to describe getting started with the itinerary schemas. As you progress with concepts, you will encounter more types such as Segments, Collections, Links and other features that are used to compose more detailed representations of itineraries.