Automatic Routing between Locations

1# Creates an itinerary, and configures it to assign automatic routes. Automatic
2# routes will assist basic itineraries by sequentially linking locations that
3# are added with directions, providing information about moving between these
4# locations.
5
6mutation CreateItineraryWithCarAutoRoute {
7  # When using the createItinerary mutation to create our itinerary
8  createItinerary(
9    itinerary: {
10      # Add our basic required fields
11      title: "Example Itinerary"
12      # Indicate the behaviour to auto route using Car as the default mode
13      autoRoute: { defaultMode: Car }
14    }
15  ) {
16    # Read back the created itinerary
17    itinerary {
18      # Access the Identifier, required for further query/mutations
19      id
20    }
21  }
22}

1# Enable "auto-route" behaviour to an existing itinerary. Auto-route will assist
2# users create itineraries with directions automatically added between locations
3
4mutation UpdateItineraryAssignCarAutoRoute {
5  # Use the updateItinerary to modify an existing itinerary
6  updateItinerary(
7    # Supply the identifier of the itinerary
8    id: "itinerary/ABC123"
9    # Change the property of autoRoute to assign a default mode
10    itinerary: { autoRoute: { defaultMode: Car } }
11  ) {
12    # Read back information
13    itinerary {
14      id
15      autoRoute {
16        defaultMode
17      }
18    }
19  }
20}

1# Updates an itinerary location and marks the itinerary location as an optional
2# stop
3
4mutation UpdateItineraryLocationAsOptional {
5  # Use updateItineraryLocation mutation for making changes to ItineraryLocation
6  updateItineraryLocation(
7    # Supply your itinerary location that you wish to make optional
8    id: "itinerary/ABC123/item/DEF456"
9    # Supply the location fields changing
10    location: {
11      # Update the location to be marked as optional
12      optional: true
13    }
14  ) {
15    # Query back your location
16    location {
17      # Optional should now be true
18      optional
19    }
20    # Optionally see what else has been affected, such as a result of the
21    # autoroute behaviour updating new and existing ItineraryDirections when
22    # using this feature.
23    cascaded {
24      created {
25        id
26        __typename
27      }
28      updated {
29        id
30        __typename
31      }
32      deletedIds
33    }
34  }
35}

1# Updates an itinerary directions to switch the mode of transportation from one
2# mode (such as car) to an alterative mode, such as foot
3
4mutation UpdateItineraryDirectionMode {
5  # Use updateItineraryDirections operation to update directions
6  updateItineraryDirections(
7    # Provide the itinerary directions ID to update
8    id: "itinerary/ABC123/item/DEF456"
9    # Supply the directions
10    directions: {
11      # Modify the route with the directions
12      route: {
13        segments: [
14          # A single route segment..., you can use multiple.
15          {
16            # Indicate the mode of transport for this route segment
17            mode: Foot
18            # Provide the information for the segment
19            useRouteSearching: true
20            # Provide positions: [] here if you want to control the routing
21          }
22        ]
23      }
24    }
25  ) {
26    # Query what was affected as a response
27    cascaded {
28      updated {
29        id
30        __typename
31      }
32    }
33  }
34}

1# Adds a new location to an itinerary that has auto route enabled, and
2# customises the auto-route behaviour so that it uses an alternative mode of
3# transport when adding. There are further behaviours provided to extend
4# auto-routing, but further than this, you can leverage the
5# createItineraryDirections mutations that can support multi-modal transport,
6# GPS sequences or further
7
8mutation CreateItineraryLocationWithAutoRouteOptions {
9  # When creating an itinerary location
10  createItineraryLocation(
11    # Provide the itinerary to modify
12    itineraryId: "itinerary/ABC"
13
14    # Provide the location/place (dummy example)
15    location: {
16      # Describe the physical place
17      place: {
18        # See how to reference and add locations properly
19        position: { lon: 123, lat: 45 }
20      }
21      # Supply specific attributes to customise this location
22      attrs: [
23        # Provide an alternative position to directions navigating to this
24        # location such as sending the user to the entrace for the location, or
25        # alternative [lon,lat]
26        {
27          id: "itinerary/location/directions-position-preference"
28          value: [123, 45.6]
29        }
30      ]
31    }
32
33    # Modify the auto route behaviour when creating this location. Note: This
34    # is not a permanent change to the itinerary, and is instead modifying
35    # the resulting autoroute that would be created at the same time
36    autoRoute: {
37      mode: Foot
38      # Other options; positions, distance, duration, useRouteSearching...
39    }
40  ) {
41    cascaded {
42      # Read back what has been created when adding
43      created {
44        # Expecting ItineraryLocation and ItineraryDirections (auto route)
45        __typename
46        id
47      }
48    }
49  }
50}