Activity Dossiers¶
An Activity Dossier
has a one-to-one relationship with an transport resource
XML Schema:
Resource Definition¶
Note
This resource can be searched, allowing to you to access a filtered set of data. See our Searching The G API documentation for details on how to query specific fields and the operators available.
Fields
Name |
Type |
Description |
---|---|---|
name required |
String |
The name of this dossier. |
date_created |
Datetime |
The time when the resource was created, in the standard Dates & Times. |
date_last_modified |
Datetime |
The time when the resource was last modified, in the standard Dates & Times. |
details |
Field |
List of free text details for this dossier. |
|
String |
|
|
String |
Informational text for this detail. |
|
Nested Object |
|
|
String |
|
|
String |
Contains the label for a dossier feature. |
|
String |
Contains a code for a dossier feature. |
type |
String |
The type of this resource. |
id read-only |
String |
|
href read-only |
Field |
|
service_code |
String |
A unique code used to identify services. |
publish_state |
String |
Can be either published or unpublished. |
features |
Field |
List of features. |
|
String |
|
|
Field |
|
|
String |
Contains the label for a dossier feature. |
|
String |
Contains a code for the dossier feature. |
dossier_segment |
Nested Object |
The segment data associated with this activity. |
|
String |
|
|
Field |
|
|
String |
A unique ASCII code to identify this segment. |
|
String |
A human-readable description of this segment. |
primary_country |
Reference Object |
The country associated to this activity. |
start_location required |
Reference Object |
The place where this activity starts. |
end_location |
Reference Object |
The place where this activity ends. |
duration_min |
String |
Approx. min duration (in hours). |
duration_max |
String |
Approx. max duration (in hours). |
distance_min |
String |
Approx. min distance (in km). |
distance_max |
String |
Approx. max distance (in km). |
price_per_person_min |
String |
Approx. min individual price. May vary by vendor. |
price_per_person_max |
String |
Approx. max individual price. May vary by vendor. |
price_per_group_min |
String |
Approx. min group price. May vary by vendor. |
price_per_group_max |
String |
Approx. max group price. May vary by vendor. |
currency |
String |
Three-character currency code for this activity. |
physical_grading |
Integer |
Internal integer code for physical grading of this activity. |
flags |
List |
List of generic flags applied to this activity. |
categories |
Field |
List of categories this activity falls under. |
|
String |
|
|
Field |
|
|
String |
|
|
Reference Object |
Parent category, can be null |
images |
Field |
Images associated with this activity. |
videos |
Field |
Videos associated with this activity. |
service_time |
Time |
The start time of the service. |
show_on_reservation_sheet |
Boolean |
Used by Local Operations to determine whether or not a service shows up on the reservation sheet sent to Suppliers. |
suggested_dossiers |
Field |
List of suggested dossiers for when this activity is used on an itinerary. |
visited_countries |
Field |
List of countries visited in this activity. |
visited_cities |
Field |
List of cities visited in this activity. |
can_be_a_highlight read-only |
Boolean |
Shows if the activity can be used as a highlight. |
Get an Activity Dossier
- GET /activity_dossiers/(string: activity_dossier_id)¶
Request
curl -H "X-Application-Key: YOUR_APPLICATION_KEY"
https://rest.gadventures.com/activity_dossiers/1003
Response
{ "name": "Monteverde Butterfly Garden Visit", "date_created": "2014-07-08T13:33:37", "date_last_modified": "2023-02-07T11:00:30", "details": [ { "id": "14962", "body": "Open 365 days per year from 08:30-16:00.", "detail_type": { "label": "Operational Notes", "code": "ACTIVITY__OPERATIONAL_NOTES" } }, { "id": "3060", "body": "Get close to butterflies, bump into giant bugs, and make friends with hairy eight-legged spiders in this collection of gardens nestled in the mountains of Monteverde. Observe caterpillars, take prize-worthy photos of the iridescent blue morpho butterfly, and check out the leaf-cutter ant colony. The nature centre is home to 30 species of butterfly, a whole bunch of insects, as well as white-faced monkeys, coatis, motmots, and more.", "detail_type": { "label": "Summary", "code": "COMMON__SUMMARY" } } ], "type": "activity_dossiers", "id": "1003", "href": "https://rest.gadventures.com/activity_dossiers/1003", "service_code": null, "publish_state": "published", "features": [], "dossier_segment": { "id": "12", "href": "https://rest.gadventures.com/dossier_segments/12", "code": "ACTIVITY__NATURE", "label": "Nature" }, "start_location": { "id": "1715062", "href": "https://rest.gadventures.com/places/1715062", "name": "Monteverde" }, "end_location": { "id": "1715062", "href": "https://rest.gadventures.com/places/1715062", "name": "Monteverde" }, "duration_min": null, "duration_max": null, "distance_min": null, "distance_max": null, "price_per_person_min": "20.00", "price_per_person_max": null, "price_per_group_min": null, "price_per_group_max": null, "currency": "USD", "physical_grading": null, "flags": [], "categories": [], "images": [ { "id": 4049, "href": "https://rest.gadventures.com/images/4049" } ], "videos": [], "service_time": null, "show_on_reservation_sheet": true, "suggested_dossiers": [], "visited_countries": [ { "id": "CR", "href": "https://rest.gadventures.com/countries/CR", "name": "Costa Rica" } ], "visited_cities": [ { "id": "1715062", "href": "https://rest.gadventures.com/places/1715062", "name": "Monteverde" } ], "can_be_a_highlight": false }