GraphQL Example Operations

The following area provides a number of example operations to perform common requirements of applications and sites using Alpaca Travel GraphQL API.

Each section of this area is broken up by the resource type. If you are still new to the Alpaca Travel GraphQL API, you may want to review the initial GraphQL Articles also located in this repository first.

Collection

• Create Collection Creates a collection for the supplied profile
• Delete Collection Item Removes a collection item from a collection
• Get Collection Loads information about the supplied collection ID
• List Collection Items Performs a query on a collection in order to obtain basic locations
• List Collections Load the collections available for a profile
• Update Collection Update the collection details

Collection Location

• Create Collection Location Creates a Collection Location within a collection
• Create Collection Location With External Reference Creates a collection location with a reference to an external primary key reference, so that we can track ID's to synchronize data between platforms
• Find Collection Location By External Refs Queries collection items based on a ID within an external platform
• Find Collection Locations By Tags Queries for collection locations from a collection by a supplied tag
• Get Collection Location Loads in a specific collection location
• Update Collection Location Add External Reference Update a record to store a corresponding identifier in an external system
• Update Collection Location Tags Simply updates tags on locations, so that they can grouped or labeled
• Update Collection Location Title Modify an existing collection location title

Icon

• Delete Icon Resource Removes an icon
• List Icon Resources Lists icons that have been created for a supplied profile

Icon Silhouette

• Create Icon Silhouette Creates an icon based on the supplied SVG path data
• Get Icon Silhouette Retrieves an icon by a specific ID
• List Icon Silhouettes Lists icons that have been created for a supplied profile
• Update Icon Silhouette Updates an icon that exists
• Update Icon Silhouette Paths Updates the paths associated to an icon

Itinerary

• Create Itinerary Creates an Itinerary you can use for a wide range of use cases such as lists or sequenced itieraries with the supplied title
• Create Itinerary With Title Creates an Itinerary you can use for a wide range of use cases such as lists or sequenced itieraries with the supplied title
• Delete Itinerary Removes an itinerary
• Find Itinerary Location Ids By Place Ids Checks whether a place has been added to an itinerary, for creating a button state on an "Add to Itinerary" button
• Get Itinerary Icons Obtain the icon set that is used in the itinerary
• List Itineraries Query the itineraries that are created and associated to a profile
• Update Itinerary Assign Car Auto Route Enable "auto-route" behaviour to an existing itinerary
• Update Itinerary Direction Mode Updates an itinerary directions to switch the mode of transportation from one mode (such as car) to an alterative mode, such as foot
• Update Itinerary Icons Updates the icons associated with an Itinerary
• Update Itinerary Photos Updates an itinerary with a selection of photos
• Update Itinerary Title Modify an existing Itinerary by changing the title

Itinerary Collection

• Create Itinerary Collection Creates an Itinerary Collection, which can be used to create new sub-listsmutation createItineraryCollection( $itineraryId: ID! $itineraryCollection: CreateItineraryCollectionInput!) { createItineraryCollection( itineraryId: $itineraryId collection: $itineraryCollection ) { collection { id } }}

Itinerary Directions

• Create Itinerary Directions Creates itinerary directions for between locations in an itinerary manually

Itinerary Link

• Create Itinerary Link Itinerary Creates a link between itineraries from one itinerary to another
• List Itinerary Links Query the itinerary linksquery listItineraryLinks($itineraryId: ID!, $first: Int!, $after: String) { itinerary( Supply the itinerary ID id: $itineraryId ) { Select the associated itinerary links using the children selector children( Limit to querying the itinerary links type: ItineraryLink Using the relay "cursor connection" specification for pagination See: https://relay

Itinerary Location

• Associate Itinerary Location Icon Associates an itinerary icon composition with an itinerary location
• Create Itinerary Location Add a location to our itinerary, associating the place to Mavis The Grocer using the Facebook Page identifier
• Create Itinerary Location With Additional Positions Adds a location to an itinerary, also supplying additional positions to help describe the location more accurately for a visiting user
• Delete Itinerary Location Removes an itinerary item, such as a location
• List Itinerary Directions For Itinerary Location Query an itinerary location and load the associated inbound or outbound directions
• List Itinerary Locations Query the itinerary locations for an itinerary, and access basic information about the place
• List Itinerary Locations With Itinerary Directions Query the itinerary locations, with information about the directions between each of the locations
• Move Itinerary Location After Sibling Move an itinerary location to a relative position to another item in the itinerary
• Move Itinerary Location To Start Reorder/move the itinerary location to the start of the sequence
• Update Itinerary Location As Optional Updates an itinerary location and marks the itinerary location as an optional stop
• Update Itinerary Location Photos Updates an itinerary location with a selection of photos
• Update Itinerary Location Segments Assign a series of segments to your itinerary locations

Itinerary Segments

• Create Itinerary Segment Creates an Itinerary Segment, which can be used to break up a list into smaller discrete sections
• Create Itinerary Segment With Title Creates an Itinerary Segment with a titlemutation createItinerarySegmentWithTitle($itineraryId: ID!, $title: String) { createItinerarySegment( itineraryId: $itineraryId segment: { title: $title } ) { segment { id } }}
• Delete Itinerary Segment Removes an itinerary item, such as a segment
• List Itinerary Segments Query the itinerary segments for an itinerary

Media

• Get Media Image Loads a media resource of type MediaImage
• Update Photo Content Modifies a media asset to change various attributes or content

Media Upload

• Process Photo Upload Progress Finalise an upload process commenced with startMediaUpload, supplying content and associations to profile
• Start Photo Upload Request information to commence a photo upload via HTTPs

Place

• Find Open Closed Times For Place By Date Range Obtain the open/closed hours for the place given a period, such as the upcoming week or future date range
• Get Place Contextual Orientation Query a place and contextualise it's location to other points of interest such as accomodation, towns, or other contextual places you are showing in relation to another place
• Get Place Currency Queries the currency used in the country for a place
• Get Place Navigation Links Queries a place to identify navigation links to generate URL's to send the user to obtain navigation links using their preferred service
• Get Place Time Zone Queries the timezone for a place
• Get Upcoming Open Closed Times Query the next series of open/closed hours for a place, in order to present information whether the venue is open, closed, opening soon, closing soon, etc
• Search Address By Position Searches to find addresses by supplied position lon/lat
• Search Locality By Position Searches to find a locality by supplied position lon/lat
• Search Place By Address Searches by text to find matching addresses

Place Provider: Australian Tourism Data Warehouse

• Get Place ATDWWinery Load information about a winery from Australian Tourism Data Warehouse
• Search Place Autocomplete From ATDW Search the Australian Tourism Data Warehouse (ATDW) for places using an autocomplete style text query

Profile

• Get Authorized Profiles Uses a query with the supplied AccessToken/API Key in order to determine the associated authorized profiles
• Get Profile Load a query by a supplied profile identifier
• Update Profile Update profile details (such as name, bio, website) for a supplied profile

Profile Social

• Approve Profile Request Approves a profile follow request to follow another profile
• Claim Profile Handle Claim a handle for a profile, associating something more friendly
• Deny Profile Follow Denies a profiles request to follow another profile
• Find Profiles By Handle Queries for profiles based on a registered handle claimed for profiles
• Get Profile Follow Request Status Requests to follow from one profile to another profile
• Get Profile Social Statistics Query to list which profiles who follows a supplied profile
• Unfollow Profile Unfollows a profile

Route

• Find Routes Between Positions Queries routes that exist through the supplied positions

Contributing

If you would like to share an operation that is useful to others, please send us a pull request with the operation created in the appropriate sub-folder. If you need to correct a comment, please update the operations directly, and not the generated markdown