Transport Dossiers¶

A Transport Dossier has a one-to-one relationship with a 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.
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.
features	Field	List of features
id read-only	String
href read-only	Field
label	String	Contains the label for a dossier feature.
code required	String	Contains a code for the dossier feature.
capacity	Integer	Approximate number of maximum passengers.
private	Boolean	True if this transport is not available to the public.
dossier_segment	Nested Object	The segment data associated with this dossier.
id read-only	String
href read-only	Field
code required	String	A unique ASCII code to identify this segment.
label	String	A human-readable description of this segment.
categories	Field	List of categories this activity falls under
id read-only	String
href read-only	Field
name required	String
category_type read-only	Reference Object	Parent category, can be null
images	Field	Images associated with this transport
videos	Field	Videos associated with this transport
flags	List	List of generic flags applied to this dossier

Get a Transport Dossier

GET /transport_dossier/(string: tranport_dossier_id)¶

Request

curl -H "X-Application-Key: YOUR_APPLICATION_KEY" 
https://rest.gadventures.com/transport_dossiers/51

Response

{
  "name": "Ferry",
  "date_created": "2014-07-02T10:50:25",
  "date_last_modified": "2020-03-24T12:00:23",
  "details": [
    {
      "id": "3161",
      "body": "Get to the next spot on your route aboard a convenient and efficient ferry boat.",
      "detail_type": {
        "label": "Summary",
        "code": "COMMON__SUMMARY"
      }
    }
  ],
  "type": "transport_dossiers",
  "id": "51",
  "href": "https://rest.gadventures.com/transport_dossiers/51",
  "publish_state": "published",
  "features": [],
  "capacity": null,
  "private": false,
  "dossier_segment": {
    "id": "10",
    "href": "https://rest.gadventures.com/dossier_segments/10",
    "code": "TRANSPORT__WATERCRAFT",
    "label": "Watercraft"
  },
  "categories": [],
  "images": [],
  "videos": [],
  "flags": []
}