Place Dossiers¶

A Place Dossier has a one-to-one relationship with a place resource and contains additional content about the country.

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	String	The name of this place 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.
id read-only	String
body required	String	Informational text for this detail.
detail_type required	Nested Object
id read-only	String
label	String	Contains the label for a dossier feature.
code required	String	Contains a code for a dossier feature.
type	String	The type of this resource.
id read-only	String
href read-only	Field
publish_state	String	Can be either published or unpublished
place required	Reference Object	The place associated to this dossier.
booking_company	Reference Object	The booking_company associated with this place dossier.
images	Field	Images associated with this place
videos	Field	Videos associated with this place
flags	List	List of generic flags applied to this dossier
can_be_a_highlight read-only	Boolean	Shows if the dossier can be used as a highlight

Get a Place Dossier

GET /place_dossiers/(string: place_dossier_id)¶

Request

curl -H "X-Application-Key: YOUR_APPLICATION_KEY" 
https://rest.gadventures.com/place_dossiers/1000

Response

{
  "name": "Pompeii",
  "date_created": "2014-07-08T13:28:58",
  "date_last_modified": "2017-06-13T13:07:40",
  "details": [
    {
      "id": "5458",
      "body": "Once a bustling city, Pompeii is now left in ruins. It was buried under ash and pumice when Mount Vesuvius erupted in 79 AD. The forum, baths, and many houses remain well preserved and provide a glimpse of what life was like in the first century.",
      "detail_type": {
        "label": "Summary",
        "code": "COMMON__SUMMARY"
      }
    },
    {
      "id": "17094",
      "body": "",
      "detail_type": {
        "label": "Description",
        "code": "COMMON__DESCRIPTION"
      }
    },
    {
      "id": "17095",
      "body": "",
      "detail_type": {
        "label": "Highlight",
        "code": "COMMON__HIGHLIGHT"
      }
    },
    {
      "id": "17096",
      "body": "",
      "detail_type": {
        "label": "Altitude Advisory",
        "code": "PLACE__ALTITUDE_ADVISORY"
      }
    },
    {
      "id": "17097",
      "body": "",
      "detail_type": {
        "label": "Crime Advisory",
        "code": "PLACE__CRIME_ADVISORY"
      }
    },
    {
      "id": "17098",
      "body": "",
      "detail_type": {
        "label": "Health Advisory",
        "code": "PLACE__HEALTH_ADVISORY"
      }
    },
    {
      "id": "17099",
      "body": "",
      "detail_type": {
        "label": "Heat Advisory",
        "code": "PLACE__HEAT_ADVISORY"
      }
    },
    {
      "id": "17100",
      "body": "",
      "detail_type": {
        "label": "Requirements",
        "code": "PLACE__REQUIREMENTS"
      }
    }
  ],
  "type": "place_dossiers",
  "id": "1000",
  "href": "https://rest.gadventures.com/place_dossiers/1000",
  "publish_state": "published",
  "place": {
    "id": "3359318",
    "href": "https://rest.gadventures.com/places/3359318",
    "name": "Pompeii"
  },
  "booking_company": {
    "id": "1",
    "href": "https://rest.gadventures.com/booking_companies/1",
    "name": "G Adventures"
  },
  "images": [
    {
      "id": 6494,
      "href": "https://rest.gadventures.com/images/6494"
    }
  ],
  "videos": [],
  "flags": [],
  "can_be_a_highlight": false
}