Data
- Default Namespace
- XML Schema File: ns0.xsd
The data in this namespace is divided into elements and types. Types define the structure of the data. Elements define specific instances of the types, and are therefore more relevant to REST endpoints, which generally consume and/or produce elements.
The following elements are members of this namespace:
- AgencyAndId
- agencyList
- AlertPatch
- graphComponentPolygons
- graphMetadata
- modeList
- MyMap
- PatchCreationResponse
- patchResponse
- PatchSet
- response
- route
- RouteData
- RouteList
- stop
- StopList
- StopTimeList
- transitError
The following types are members of this namespace:
- absoluteDirection
- abstractPatch
- agencyAndId
- agencyAndIdType
- agencyList
- alert
- alertPatch
- encodedPolylineBean
- entry
- fare
- fareType
- geometry
- graphComponent
- graphComponentPolygons
- graphMetadata
- itinerary
- leg
- lineString
- mapType
- modeList
- money
- note
- patchCreationResponse
- patchResponse
- patchSet
- place
- plannerError
- relativeDirection
- response
- routeData
- routeList
- routeVariant
- stop
- stopList
- stopTime
- stopTimeList
- transitError
- transitRoute
- translatedString
- TraverseMode
- tripPlan
- walkStep
- wrappedCurrency
Element AgencyAndId
- Type: agencyAndIdType
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<AgencyAndId agency="..." id="..." />
Example JSON
{
"agency" : "...",
"id" : "..."
}
Element agencyList
- Type: agencyList
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<agencyList>
<agencyIds>
<agencyIds>
<!--content of type 'string'-->
...
</agencyIds>
<agencyIds>
<!--(another 'string' type)-->
</agencyIds>
<!--...more "agencyIds" elements...-->
</agencyIds>
</agencyList>
Example JSON
{
"agencyIds" : [ "...", ... ]
}
Element AlertPatch
- Type: alertPatch
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<AlertPatch>
<cancelled>
<!--content of type 'boolean'-->
...
</cancelled>
<stop agency="..." id="...">
<!--content of type 'agencyAndIdType'-->
</stop>
<trip agency="..." id="...">
<!--content of type 'agencyAndIdType'-->
</trip>
<route agency="..." id="...">
<!--content of type 'agencyAndIdType'-->
</route>
<direction>
<!--content of type 'string'-->
...
</direction>
<id>
<!--content of type 'string'-->
...
</id>
<alert>
<!--content of type 'alert'-->
<alertDescriptionText>
<!--content of type 'translatedString'-->
<translations>
<!--content of type 'mapType'-->
<entry key="..." value="...">
<!--content of type 'entry'-->
</entry>
<entry>
<!--(another 'entry' type)-->
</entry>
<!--...more "entry" elements...-->
</translations>
</alertDescriptionText>
<alertUrl>
<!--content of type 'translatedString'-->
<translations>
<!--content of type 'mapType'-->
<entry key="..." value="...">
<!--content of type 'entry'-->
</entry>
<entry>
<!--(another 'entry' type)-->
</entry>
<!--...more "entry" elements...-->
</translations>
</alertUrl>
<alertHeaderText>
<!--content of type 'translatedString'-->
<translations>
<!--content of type 'mapType'-->
<entry key="..." value="...">
<!--content of type 'entry'-->
</entry>
<entry>
<!--(another 'entry' type)-->
</entry>
<!--...more "entry" elements...-->
</translations>
</alertHeaderText>
<effectiveStartDate>
<!--content of type 'dateTime'-->
...
</effectiveStartDate>
</alert>
</AlertPatch>
Example JSON
{
"cancelled" : false,
"stop" : {
"agency" : "...",
"id" : "..."
},
"trip" : {
"agency" : "...",
"id" : "..."
},
"route" : {
"agency" : "...",
"id" : "..."
},
"direction" : "...",
"id" : "...",
"alert" : {
"alertDescriptionText" : {
"translations" : {
"entry" : [ {
"key" : "...",
"value" : "..."
}, ... ]
}
},
"alertUrl" : {
"translations" : {
"entry" : [ {
"key" : "...",
"value" : "..."
}, ... ]
}
},
"alertHeaderText" : {
"translations" : {
"entry" : [ {
"key" : "...",
"value" : "..."
}, ... ]
}
},
"effectiveStartDate" : "..."
}
}
Element graphComponentPolygons
- Type: graphComponentPolygons
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<graphComponentPolygons>
<components>
<components>
<!--content of type 'graphComponent'-->
<polygon>
<!--content of type 'geometry'-->
<SRID>
<!--content of type 'int'-->
...
</SRID>
<userData>
<!--content of type 'anyType'-->
<!--custom xml-->
</userData>
</polygon>
</components>
<components>
<!--(another 'graphComponent' type)-->
</components>
<!--...more "components" elements...-->
</components>
</graphComponentPolygons>
Example JSON
{
"components" : [ {
"polygon" : {
"SRID" : ...,
"userData" : {
}
}
}, ... ]
}
Element graphMetadata
- Type: graphMetadata
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<graphMetadata>
<lowerLeftLatitude>
<!--content of type 'double'-->
...
</lowerLeftLatitude>
<upperRightLatitude>
<!--content of type 'double'-->
...
</upperRightLatitude>
<upperRightLongitude>
<!--content of type 'double'-->
...
</upperRightLongitude>
<lowerLeftLongitude>
<!--content of type 'double'-->
...
</lowerLeftLongitude>
<minLatitude>
<!--content of type 'double'-->
...
</minLatitude>
<minLongitude>
<!--content of type 'double'-->
...
</minLongitude>
<maxLatitude>
<!--content of type 'double'-->
...
</maxLatitude>
<maxLongitude>
<!--content of type 'double'-->
...
</maxLongitude>
<transitModes>
<!--content of type 'TraverseMode'-->
...
</transitModes>
<transitModes>
<!--(another 'TraverseMode' type)-->
</transitModes>
<!--...more "transitModes" elements...-->
</graphMetadata>
Example JSON
{
"lowerLeftLatitude" : ...,
"upperRightLatitude" : ...,
"upperRightLongitude" : ...,
"lowerLeftLongitude" : ...,
"minLatitude" : ...,
"minLongitude" : ...,
"maxLatitude" : ...,
"maxLongitude" : ...,
"transitModes" : [ {
}, ... ]
}
Element modeList
- Type: modeList
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<modeList>
<modes>
<modes>
<!--content of type 'TraverseMode'-->
...
</modes>
<modes>
<!--(another 'TraverseMode' type)-->
</modes>
<!--...more "modes" elements...-->
</modes>
</modeList>
Example JSON
{
"modes" : [ {
}, ... ]
}
Element MyMap
- Type: mapType
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<MyMap>
<entry key="..." value="...">
<!--content of type 'entry'-->
</entry>
<entry>
<!--(another 'entry' type)-->
</entry>
<!--...more "entry" elements...-->
</MyMap>
Example JSON
{
"entry" : [ {
"key" : "...",
"value" : "..."
}, ... ]
}
Element PatchCreationResponse
- Type: patchCreationResponse
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<PatchCreationResponse>
<status>
<!--content of type 'string'-->
...
</status>
</PatchCreationResponse>
Example JSON
{
"status" : "..."
}
Element patchResponse
- Type: patchResponse
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<patchResponse>
<patches>
<AlertPatch>
<!--content of type 'alertPatch'-->
<cancelled>
<!--content of type 'boolean'-->
...
</cancelled>
<stop agency="..." id="...">
<!--content of type 'agencyAndIdType'-->
</stop>
<trip agency="..." id="...">
<!--content of type 'agencyAndIdType'-->
</trip>
<route agency="..." id="...">
<!--content of type 'agencyAndIdType'-->
</route>
<direction>
<!--content of type 'string'-->
...
</direction>
<id>
<!--content of type 'string'-->
...
</id>
<alert>
<!--content of type 'alert'-->
<alertDescriptionText>
<!--content of type 'translatedString'-->
<translations>
<!--content of type 'mapType'-->
<entry key="..." value="...">
<!--content of type 'entry'-->
</entry>
<entry>
<!--(another 'entry' type)-->
</entry>
<!--...more "entry" elements...-->
</translations>
</alertDescriptionText>
<alertUrl>
<!--content of type 'translatedString'-->
<translations>
<!--content of type 'mapType'-->
<entry key="..." value="...">
<!--content of type 'entry'-->
</entry>
<entry>
<!--(another 'entry' type)-->
</entry>
<!--...more "entry" elements...-->
</translations>
</alertUrl>
<alertHeaderText>
<!--content of type 'translatedString'-->
<translations>
<!--content of type 'mapType'-->
<entry key="..." value="...">
<!--content of type 'entry'-->
</entry>
<entry>
<!--(another 'entry' type)-->
</entry>
<!--...more "entry" elements...-->
</translations>
</alertHeaderText>
<effectiveStartDate>
<!--content of type 'dateTime'-->
...
</effectiveStartDate>
</alert>
</AlertPatch>
<AlertPatch>
<!--(another 'alertPatch' type)-->
</AlertPatch>
<!--...more "AlertPatch" elements...-->
</patches>
</patchResponse>
Example JSON
{
"patches" : [ {
"cancelled" : false,
"stop" : {
"agency" : "...",
"id" : "..."
},
"trip" : {
"agency" : "...",
"id" : "..."
},
"route" : {
"agency" : "...",
"id" : "..."
},
"direction" : "...",
"id" : "...",
"alert" : {
"alertDescriptionText" : {
"translations" : {
"entry" : [ {
"key" : "...",
"value" : "..."
}, ... ]
}
},
"alertUrl" : {
"translations" : {
"entry" : [ {
"key" : "...",
"value" : "..."
}, ... ]
}
},
"alertHeaderText" : {
"translations" : {
"entry" : [ {
"key" : "...",
"value" : "..."
}, ... ]
}
},
"effectiveStartDate" : "..."
}
}, ... ]
}
Element PatchSet
- Type: patchSet
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<PatchSet>
<AlertPatch>
<!--content of type 'alertPatch'-->
<cancelled>
<!--content of type 'boolean'-->
...
</cancelled>
<stop agency="..." id="...">
<!--content of type 'agencyAndIdType'-->
</stop>
<trip agency="..." id="...">
<!--content of type 'agencyAndIdType'-->
</trip>
<route agency="..." id="...">
<!--content of type 'agencyAndIdType'-->
</route>
<direction>
<!--content of type 'string'-->
...
</direction>
<id>
<!--content of type 'string'-->
...
</id>
<alert>
<!--content of type 'alert'-->
<alertDescriptionText>
<!--content of type 'translatedString'-->
<translations>
<!--content of type 'mapType'-->
<entry key="..." value="...">
<!--content of type 'entry'-->
</entry>
<entry>
<!--(another 'entry' type)-->
</entry>
<!--...more "entry" elements...-->
</translations>
</alertDescriptionText>
<alertUrl>
<!--content of type 'translatedString'-->
<translations>
<!--content of type 'mapType'-->
<entry key="..." value="...">
<!--content of type 'entry'-->
</entry>
<entry>
<!--(another 'entry' type)-->
</entry>
<!--...more "entry" elements...-->
</translations>
</alertUrl>
<alertHeaderText>
<!--content of type 'translatedString'-->
<translations>
<!--content of type 'mapType'-->
<entry key="..." value="...">
<!--content of type 'entry'-->
</entry>
<entry>
<!--(another 'entry' type)-->
</entry>
<!--...more "entry" elements...-->
</translations>
</alertHeaderText>
<effectiveStartDate>
<!--content of type 'dateTime'-->
...
</effectiveStartDate>
</alert>
</AlertPatch>
<AlertPatch>
<!--(another 'alertPatch' type)-->
</AlertPatch>
<!--...more "AlertPatch" elements...-->
</PatchSet>
Example JSON
{
"AlertPatch" : [ {
"cancelled" : false,
"stop" : {
"agency" : "...",
"id" : "..."
},
"trip" : {
"agency" : "...",
"id" : "..."
},
"route" : {
"agency" : "...",
"id" : "..."
},
"direction" : "...",
"id" : "...",
"alert" : {
"alertDescriptionText" : {
"translations" : {
"entry" : [ {
"key" : "...",
"value" : "..."
}, ... ]
}
},
"alertUrl" : {
"translations" : {
"entry" : [ {
"key" : "...",
"value" : "..."
}, ... ]
}
},
"alertHeaderText" : {
"translations" : {
"entry" : [ {
"key" : "...",
"value" : "..."
}, ... ]
}
},
"effectiveStartDate" : "..."
}
}, ... ]
}
Element response
- Type: response
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<response>
<requestParameters>
<!--content of type 'null'-->
<entry>
<key>
<!--type 'string'-->
...
</key>
<value>
<!--content of type 'string'-->
...
</value>
</entry>
<entry>
<key>
<!--(another 'string' type)-->
</key>
<value>
<!--(another 'string' type)-->
</value>
</entry>
<!--...more entries...-->
</requestParameters>
<plan>
<!--content of type 'tripPlan'-->
<date>
<!--content of type 'dateTime'-->
...
</date>
<from orig="..." zoneId="...">
<!--content of type 'place'-->
<name>
<!--content of type 'string'-->
...
</name>
<stopId>
<!--content of type 'agencyAndId'-->
<id>
<!--content of type 'string'-->
...
</id>
<agencyId>
<!--content of type 'string'-->
...
</agencyId>
</stopId>
<stopCode>
<!--content of type 'string'-->
...
</stopCode>
<lon>
<!--content of type 'double'-->
...
</lon>
<lat>
<!--content of type 'double'-->
...
</lat>
<arrival>
<!--content of type 'dateTime'-->
...
</arrival>
<departure>
<!--content of type 'dateTime'-->
...
</departure>
</from>
<to orig="..." zoneId="...">
<!--content of type 'place'-->
<name>
<!--content of type 'string'-->
...
</name>
<stopId>
<!--content of type 'agencyAndId'-->
<id>
<!--content of type 'string'-->
...
</id>
<agencyId>
<!--content of type 'string'-->
...
</agencyId>
</stopId>
<stopCode>
<!--content of type 'string'-->
...
</stopCode>
<lon>
<!--content of type 'double'-->
...
</lon>
<lat>
<!--content of type 'double'-->
...
</lat>
<arrival>
<!--content of type 'dateTime'-->
...
</arrival>
<departure>
<!--content of type 'dateTime'-->
...
</departure>
</to>
<itineraries>
<itinerary>
<!--content of type 'itinerary'-->
<duration>
<!--content of type 'long'-->
...
</duration>
<startTime>
<!--content of type 'dateTime'-->
...
</startTime>
<endTime>
<!--content of type 'dateTime'-->
...
</endTime>
<walkTime>
<!--content of type 'long'-->
...
</walkTime>
<transitTime>
<!--content of type 'long'-->
...
</transitTime>
<waitingTime>
<!--content of type 'long'-->
...
</waitingTime>
<walkDistance>
<!--content of type 'double'-->
...
</walkDistance>
<elevationLost>
<!--content of type 'double'-->
...
</elevationLost>
<elevationGained>
<!--content of type 'double'-->
...
</elevationGained>
<transfers>
<!--content of type 'int'-->
...
</transfers>
<fare>
<!--content of type 'fare'-->
<fare>
<!--content of type 'null'-->
<entry>
<key>
<!--type 'fareType'-->
...
</key>
<value>
<!--content of type 'money'-->
<cents>
<!--content of type 'int'-->
...
</cents>
<currency>
<!--content of type 'wrappedCurrency'-->
</currency>
</value>
</entry>
<entry>
<key>
<!--(another 'fareType' type)-->
</key>
<value>
<!--(another 'money' type)-->
</value>
</entry>
<!--...more entries...-->
</fare>
</fare>
<legs>
<leg mode="..." route="..." agencyName="..." agencyUrl="..." agencyTimeZoneOffset="..." routeColor="..." routeTextColor="..." interlineWithPreviousLeg="..." tripShortName="..." headsign="..." agencyId="..." tripId="..." routeShortName="..." routeLongName="..." boardRule="..." alightRule="...">
<!--content of type 'leg'-->
<startTime>
<!--content of type 'dateTime'-->
...
</startTime>
<endTime>
<!--content of type 'dateTime'-->
...
</endTime>
<distance>
<!--content of type 'double'-->
...
</distance>
<from orig="..." zoneId="...">
<!--content of type 'place'-->
<name>
<!--content of type 'string'-->
...
</name>
<stopId>
<!--content of type 'agencyAndId'-->
<id>
<!--content of type 'string'-->
...
</id>
<agencyId>
<!--content of type 'string'-->
...
</agencyId>
</stopId>
<stopCode>
<!--content of type 'string'-->
...
</stopCode>
<lon>
<!--content of type 'double'-->
...
</lon>
<lat>
<!--content of type 'double'-->
...
</lat>
<arrival>
<!--content of type 'dateTime'-->
...
</arrival>
<departure>
<!--content of type 'dateTime'-->
...
</departure>
</from>
<to orig="..." zoneId="...">
<!--content of type 'place'-->
<name>
<!--content of type 'string'-->
...
</name>
<stopId>
<!--content of type 'agencyAndId'-->
<id>
<!--content of type 'string'-->
...
</id>
<agencyId>
<!--content of type 'string'-->
...
</agencyId>
</stopId>
<stopCode>
<!--content of type 'string'-->
...
</stopCode>
<lon>
<!--content of type 'double'-->
...
</lon>
<lat>
<!--content of type 'double'-->
...
</lat>
<arrival>
<!--content of type 'dateTime'-->
...
</arrival>
<departure>
<!--content of type 'dateTime'-->
...
</departure>
</to>
<intermediateStops>
<stop orig="..." zoneId="...">
<!--content of type 'place'-->
<name>
<!--content of type 'string'-->
...
</name>
<stopId>
<!--content of type 'agencyAndId'-->
<id>
<!--content of type 'string'-->
...
</id>
<agencyId>
<!--content of type 'string'-->
...
</agencyId>
</stopId>
<stopCode>
<!--content of type 'string'-->
...
</stopCode>
<lon>
<!--content of type 'double'-->
...
</lon>
<lat>
<!--content of type 'double'-->
...
</lat>
<arrival>
<!--content of type 'dateTime'-->
...
</arrival>
<departure>
<!--content of type 'dateTime'-->
...
</departure>
</stop>
<stop>
<!--(another 'place' type)-->
</stop>
<!--...more "stop" elements...-->
</intermediateStops>
<legGeometry>
<!--content of type 'encodedPolylineBean'-->
<points>
<!--content of type 'string'-->
...
</points>
<length>
<!--content of type 'int'-->
...
</length>
</legGeometry>
<steps>
<walkSteps>
<!--content of type 'walkStep'-->
<distance>
<!--content of type 'double'-->
...
</distance>
<relativeDirection>
<!--content of type 'relativeDirection'-->
...
</relativeDirection>
<streetName>
<!--content of type 'string'-->
...
</streetName>
<absoluteDirection>
<!--content of type 'absoluteDirection'-->
...
</absoluteDirection>
<exit>
<!--content of type 'string'-->
...
</exit>
<stayOn>
<!--content of type 'boolean'-->
...
</stayOn>
<bogusName>
<!--content of type 'boolean'-->
...
</bogusName>
<lon>
<!--content of type 'double'-->
...
</lon>
<lat>
<!--content of type 'double'-->
...
</lat>
<elevation>
<!--content of type 'string'-->
...
</elevation>
<alerts>
<!--content of type 'alert'-->
<alertDescriptionText>
<!--content of type 'translatedString'-->
<translations>
<!--content of type 'mapType'-->
<entry key="..." value="...">
<!--content of type 'entry'-->
</entry>
<entry>
<!--(another 'entry' type)-->
</entry>
<!--...more "entry" elements...-->
</translations>
</alertDescriptionText>
<alertUrl>
<!--content of type 'translatedString'-->
<translations>
<!--content of type 'mapType'-->
<entry key="..." value="...">
<!--content of type 'entry'-->
</entry>
<entry>
<!--(another 'entry' type)-->
</entry>
<!--...more "entry" elements...-->
</translations>
</alertUrl>
<alertHeaderText>
<!--content of type 'translatedString'-->
<translations>
<!--content of type 'mapType'-->
<entry key="..." value="...">
<!--content of type 'entry'-->
</entry>
<entry>
<!--(another 'entry' type)-->
</entry>
<!--...more "entry" elements...-->
</translations>
</alertHeaderText>
<effectiveStartDate>
<!--content of type 'dateTime'-->
...
</effectiveStartDate>
</alerts>
<alerts>
<!--(another 'alert' type)-->
</alerts>
<!--...more "alerts" elements...-->
</walkSteps>
<walkSteps>
<!--(another 'walkStep' type)-->
</walkSteps>
<!--...more "walkSteps" elements...-->
</steps>
<notes>
<!--content of type 'note'-->
<text>
<!--content of type 'string'-->
...
</text>
</notes>
<notes>
<!--(another 'note' type)-->
</notes>
<!--...more "notes" elements...-->
<alerts>
<!--content of type 'alert'-->
<alertDescriptionText>
<!--content of type 'translatedString'-->
<translations>
<!--content of type 'mapType'-->
<entry key="..." value="...">
<!--content of type 'entry'-->
</entry>
<entry>
<!--(another 'entry' type)-->
</entry>
<!--...more "entry" elements...-->
</translations>
</alertDescriptionText>
<alertUrl>
<!--content of type 'translatedString'-->
<translations>
<!--content of type 'mapType'-->
<entry key="..." value="...">
<!--content of type 'entry'-->
</entry>
<entry>
<!--(another 'entry' type)-->
</entry>
<!--...more "entry" elements...-->
</translations>
</alertUrl>
<alertHeaderText>
<!--content of type 'translatedString'-->
<translations>
<!--content of type 'mapType'-->
<entry key="..." value="...">
<!--content of type 'entry'-->
</entry>
<entry>
<!--(another 'entry' type)-->
</entry>
<!--...more "entry" elements...-->
</translations>
</alertHeaderText>
<effectiveStartDate>
<!--content of type 'dateTime'-->
...
</effectiveStartDate>
</alerts>
<alerts>
<!--(another 'alert' type)-->
</alerts>
<!--...more "alerts" elements...-->
<duration>
<!--content of type 'long'-->
...
</duration>
</leg>
<leg>
<!--(another 'leg' type)-->
</leg>
<!--...more "leg" elements...-->
</legs>
<tooSloped>
<!--content of type 'boolean'-->
...
</tooSloped>
</itinerary>
<itinerary>
<!--(another 'itinerary' type)-->
</itinerary>
<!--...more "itinerary" elements...-->
</itineraries>
</plan>
<error>
<!--content of type 'plannerError'-->
<id>
<!--content of type 'int'-->
...
</id>
<missing>
<!--content of type 'string'-->
...
</missing>
<missing>
<!--(another 'string' type)-->
</missing>
<!--...more "missing" elements...-->
<noPath>
<!--content of type 'boolean'-->
...
</noPath>
</error>
</response>
Example JSON
{
"requestParameters" : [ {
"..." : ...
}, {
} ],
"plan" : {
"date" : "...",
"from" : {
"orig" : "...",
"zoneId" : "...",
"name" : "...",
"stopId" : {
"id" : "...",
"agencyId" : "..."
},
"stopCode" : "...",
"lon" : ...,
"lat" : ...,
"arrival" : "...",
"departure" : "..."
},
"to" : {
"orig" : "...",
"zoneId" : "...",
"name" : "...",
"stopId" : {
"id" : "...",
"agencyId" : "..."
},
"stopCode" : "...",
"lon" : ...,
"lat" : ...,
"arrival" : "...",
"departure" : "..."
},
"itineraries" : [ {
"duration" : ...,
"startTime" : "...",
"endTime" : "...",
"walkTime" : ...,
"transitTime" : ...,
"waitingTime" : ...,
"walkDistance" : ...,
"elevationLost" : ...,
"elevationGained" : ...,
"transfers" : ...,
"fare" : {
"fare" : [ {
"..." : ...
}, {
} ]
},
"legs" : [ {
"mode" : "...",
"route" : "...",
"agencyName" : "...",
"agencyUrl" : "...",
"agencyTimeZoneOffset" : ...,
"routeColor" : "...",
"routeTextColor" : "...",
"interlineWithPreviousLeg" : false,
"tripShortName" : "...",
"headsign" : "...",
"agencyId" : "...",
"tripId" : "...",
"routeShortName" : "...",
"routeLongName" : "...",
"boardRule" : "...",
"alightRule" : "...",
"startTime" : "...",
"endTime" : "...",
"distance" : ...,
"from" : {
"orig" : "...",
"zoneId" : "...",
"name" : "...",
"stopId" : {
"id" : "...",
"agencyId" : "..."
},
"stopCode" : "...",
"lon" : ...,
"lat" : ...,
"arrival" : "...",
"departure" : "..."
},
"to" : {
"orig" : "...",
"zoneId" : "...",
"name" : "...",
"stopId" : {
"id" : "...",
"agencyId" : "..."
},
"stopCode" : "...",
"lon" : ...,
"lat" : ...,
"arrival" : "...",
"departure" : "..."
},
"intermediateStops" : [ {
"orig" : "...",
"zoneId" : "...",
"name" : "...",
"stopId" : {
"id" : "...",
"agencyId" : "..."
},
"stopCode" : "...",
"lon" : ...,
"lat" : ...,
"arrival" : "...",
"departure" : "..."
}, ... ],
"legGeometry" : {
"points" : "...",
"length" : ...
},
"steps" : [ {
"distance" : ...,
"relativeDirection" : {
},
"streetName" : "...",
"absoluteDirection" : {
},
"exit" : "...",
"stayOn" : false,
"bogusName" : false,
"lon" : ...,
"lat" : ...,
"elevation" : "...",
"alerts" : [ {
"alertDescriptionText" : {
"translations" : {
"entry" : [ {
"key" : "...",
"value" : "..."
}, ... ]
}
},
"alertUrl" : {
"translations" : {
"entry" : [ {
"key" : "...",
"value" : "..."
}, ... ]
}
},
"alertHeaderText" : {
"translations" : {
"entry" : [ {
"key" : "...",
"value" : "..."
}, ... ]
}
},
"effectiveStartDate" : "..."
}, ... ]
}, ... ],
"notes" : [ {
"text" : "..."
}, ... ],
"alerts" : [ {
"alertDescriptionText" : {
"translations" : {
"entry" : [ {
"key" : "...",
"value" : "..."
}, ... ]
}
},
"alertUrl" : {
"translations" : {
"entry" : [ {
"key" : "...",
"value" : "..."
}, ... ]
}
},
"alertHeaderText" : {
"translations" : {
"entry" : [ {
"key" : "...",
"value" : "..."
}, ... ]
}
},
"effectiveStartDate" : "..."
}, ... ],
"duration" : ...
}, ... ],
"tooSloped" : false
}, ... ]
},
"error" : {
"id" : ...,
"missing" : [ "...", ... ],
"noPath" : false
}
}
Element route
- Type: transitRoute
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<route routeShortName="..." routeLongName="..." routeName="..." url="...">
<id agency="..." id="...">
<!--content of type 'agencyAndIdType'-->
</id>
</route>
Example JSON
{
"routeShortName" : "...",
"routeLongName" : "...",
"routeName" : "...",
"url" : "...",
"id" : {
"agency" : "...",
"id" : "..."
}
}
Element RouteData
- Type: routeData
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<RouteData>
<id agency="..." id="...">
<!--content of type 'agencyAndIdType'-->
</id>
<variants>
<variants>
<!--content of type 'routeVariant'-->
<direction>
<!--content of type 'string'-->
...
</direction>
<name>
<!--content of type 'string'-->
...
</name>
<trips agency="..." id="...">
<!--content of type 'agencyAndIdType'-->
</trips>
<stops agency="..." id="...">
<!--content of type 'agencyAndIdType'-->
</stops>
<geometry>
<!--content of type 'lineString'-->
<SRID>
<!--content of type 'int'-->
...
</SRID>
<userData>
<!--content of type 'anyType'-->
<!--custom xml-->
</userData>
</geometry>
</variants>
<variants>
<!--(another 'routeVariant' type)-->
</variants>
<!--...more "variants" elements...-->
</variants>
<directions>
<directions>
<!--content of type 'string'-->
...
</directions>
<directions>
<!--(another 'string' type)-->
</directions>
<!--...more "directions" elements...-->
</directions>
</RouteData>
Example JSON
{
"id" : {
"agency" : "...",
"id" : "..."
},
"variants" : [ {
"direction" : "...",
"name" : "...",
"trips" : {
"agency" : "...",
"id" : "..."
},
"stops" : {
"agency" : "...",
"id" : "..."
},
"geometry" : {
"SRID" : ...,
"userData" : {
}
}
}, ... ],
"directions" : [ "...", ... ]
}
Element RouteList
- Type: routeList
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<RouteList>
<route routeShortName="..." routeLongName="..." routeName="..." url="...">
<!--content of type 'transitRoute'-->
<id agency="..." id="...">
<!--content of type 'agencyAndIdType'-->
</id>
</route>
<route>
<!--(another 'transitRoute' type)-->
</route>
<!--...more "route" elements...-->
</RouteList>
Example JSON
{
"route" : [ {
"routeShortName" : "...",
"routeLongName" : "...",
"routeName" : "...",
"url" : "...",
"id" : {
"agency" : "...",
"id" : "..."
}
}, ... ]
}
Element stop
- Type: stop
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<stop lon="..." lat="..." stopCode="..." stopName="...">
<id agency="..." id="...">
<!--content of type 'agencyAndIdType'-->
</id>
<route>
<!--content of type 'agencyAndId'-->
<id>
<!--content of type 'string'-->
...
</id>
<agencyId>
<!--content of type 'string'-->
...
</agencyId>
</route>
<route>
<!--(another 'agencyAndId' type)-->
</route>
<!--...more "route" elements...-->
</stop>
Example JSON
{
"lon" : ...,
"lat" : ...,
"stopCode" : "...",
"stopName" : "...",
"id" : {
"agency" : "...",
"id" : "..."
},
"route" : [ {
"id" : "...",
"agencyId" : "..."
}, ... ]
}
Element StopList
- Type: stopList
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<StopList>
<stop lon="..." lat="..." stopCode="..." stopName="...">
<!--content of type 'stop'-->
<id agency="..." id="...">
<!--content of type 'agencyAndIdType'-->
</id>
<route>
<!--content of type 'agencyAndId'-->
<id>
<!--content of type 'string'-->
...
</id>
<agencyId>
<!--content of type 'string'-->
...
</agencyId>
</route>
<route>
<!--(another 'agencyAndId' type)-->
</route>
<!--...more "route" elements...-->
</stop>
<stop>
<!--(another 'stop' type)-->
</stop>
<!--...more "stop" elements...-->
</StopList>
Example JSON
{
"stop" : [ {
"lon" : ...,
"lat" : ...,
"stopCode" : "...",
"stopName" : "...",
"id" : {
"agency" : "...",
"id" : "..."
},
"route" : [ {
"id" : "...",
"agencyId" : "..."
}, ... ]
}, ... ]
}
Element StopTimeList
- Type: stopTimeList
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<StopTimeList>
<stopTime time="...">
<!--content of type 'stopTime'-->
<trip agency="..." id="...">
<!--content of type 'agencyAndIdType'-->
</trip>
<stop agency="..." id="...">
<!--content of type 'agencyAndIdType'-->
</stop>
</stopTime>
<stopTime>
<!--(another 'stopTime' type)-->
</stopTime>
<!--...more "stopTime" elements...-->
</StopTimeList>
Example JSON
{
"stopTime" : [ {
"time" : ...,
"trip" : {
"agency" : "...",
"id" : "..."
},
"stop" : {
"agency" : "...",
"id" : "..."
}
}, ... ]
}
Element transitError
- Type: transitError
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<transitError>
<message>
<!--content of type 'string'-->
...
</message>
</transitError>
Example JSON
{
"message" : "..."
}
Type absoluteDirection
An absolute cardinal or intermediate direction.
Possible Values
| value | description |
|---|---|
| NORTH | |
| NORTHEAST | |
| EAST | |
| SOUTHEAST | |
| SOUTH | |
| SOUTHWEST | |
| WEST | |
| NORTHWEST |
Type abstractPatch
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| id (string) | 0/1 | (no documentation provided) |
| alert (alert) | 0/1 | (no documentation provided) |
Type agencyAndId
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| id (string) | 0/1 | (no documentation provided) |
| agencyId (string) | 0/1 | (no documentation provided) |
Type agencyAndIdType
Attributes
| name | type | description |
|---|---|---|
| agency | string | (no documentation provided) |
| id | string | (no documentation provided) |
Type agencyList
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| agencyIds/agencyIds (string) | 0/unbounded | (no documentation provided) |
Type alert
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| alertDescriptionText (translatedString) | 0/1 | (no documentation provided) |
| alertUrl (translatedString) | 0/1 | (no documentation provided) |
| alertHeaderText (translatedString) | 0/1 | (no documentation provided) |
| effectiveStartDate (dateTime) | 0/1 | (no documentation provided) |
Type alertPatch
- Extends: abstractPatch
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| cancelled (boolean) | 1/1 | (no documentation provided) |
| stop (agencyAndIdType) | 0/1 | (no documentation provided) |
| trip (agencyAndIdType) | 0/1 | (no documentation provided) |
| route (agencyAndIdType) | 0/1 | (no documentation provided) |
| direction (string) | 0/1 | (no documentation provided) |
Type encodedPolylineBean
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| points (string) | 0/1 | (no documentation provided) |
| length (int) | 1/1 | (no documentation provided) |
Type entry
Attributes
| name | type | description |
|---|---|---|
| key | string | (no documentation provided) |
| value | string | (no documentation provided) |
Type fare
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| fare () | 0/1 | (no documentation provided) |
Type geometry
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| SRID (int) | 1/1 | (no documentation provided) |
| userData (anyType) | 0/1 | (no documentation provided) |
Type graphComponent
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| polygon (geometry) | 0/1 | (no documentation provided) |
Type graphComponentPolygons
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| components/components (graphComponent) | 0/unbounded | (no documentation provided) |
Type graphMetadata
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| lowerLeftLatitude (double) | 1/1 | (no documentation provided) |
| upperRightLatitude (double) | 1/1 | (no documentation provided) |
| upperRightLongitude (double) | 1/1 | (no documentation provided) |
| lowerLeftLongitude (double) | 1/1 | (no documentation provided) |
| minLatitude (double) | 1/1 | The bounding box of the graph, in decimal degrees. These are the old, deprecated names; the new names are the lowerLeft/upperRight. |
| minLongitude (double) | 1/1 | The bounding box of the graph, in decimal degrees. These are the old, deprecated names; the new names are the lowerLeft/upperRight. |
| maxLatitude (double) | 1/1 | The bounding box of the graph, in decimal degrees. These are the old, deprecated names; the new names are the lowerLeft/upperRight. |
| maxLongitude (double) | 1/1 | The bounding box of the graph, in decimal degrees. These are the old, deprecated names; the new names are the lowerLeft/upperRight. |
| transitModes (TraverseMode) | 0/unbounded | (no documentation provided) |
Type itinerary
An Itinerary is one complete way of getting from the start location to the end location.
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| duration (long) | 1/1 | Duration of the trip on this itinerary, in milliseconds. |
| startTime (dateTime) | 0/1 | Time that the trip departs. |
| endTime (dateTime) | 0/1 | Time that the trip arrives. |
| walkTime (long) | 1/1 | How much time is spent walking, in seconds. |
| transitTime (long) | 1/1 | How much time is spent on transit, in seconds. |
| waitingTime (long) | 1/1 | How much time is spent waiting for transit to arrive, in seconds. |
| walkDistance (double) | 0/1 | How far the user has to walk, in meters. |
| elevationLost (double) | 0/1 | How much elevation is lost, in total, over the course of the trip, in meters. As an example, a trip that went from the top of Mount Everest straight down to sea level, then back up K2, then back down again would have an elevationLost of Everest + K2. |
| elevationGained (double) | 0/1 | How much elevation is gained, in total, over the course of the trip, in meters. See elevationLost. |
| transfers (int) | 0/1 | The number of transfers this trip has. |
| fare (fare) | 0/1 | The cost of this trip |
| legs/leg (leg) | 0/unbounded | A list of Legs. Each Leg is either a walking (cycling, car) portion of the trip, or a transit trip on a particular vehicle. So a trip where the use walks to the Q train, transfers to the 6, then walks to their destination, has four legs. |
| tooSloped (boolean) | 1/1 | This itinerary has a greater slope than the user requested (but there are no possible itineraries with a good slope). |
Type leg
One leg of a trip -- that is, a temporally continuous piece of the journey that takes place on a particular vehicle (or on foot).
Attributes
| name | type | description |
|---|---|---|
| mode | string | The mode (e.g., Walk) used when traversing this leg. |
| route | string | For transit legs, the route of the bus or train being used. For non-transit legs, the name of the street being traversed. |
| agencyName | string | (no documentation provided) |
| agencyUrl | string | (no documentation provided) |
| agencyTimeZoneOffset | int | (no documentation provided) |
| routeColor | string | For transit leg, the route's (background) color (if one exists). For non-transit legs, null. |
| routeTextColor | string | For transit leg, the route's text color (if one exists). For non-transit legs, null. |
| interlineWithPreviousLeg | boolean | For transit legs, if the rider should stay on the vehicle as it changes route names. |
| tripShortName | string | For transit leg, the trip's short name (if one exists). For non-transit legs, null. |
| headsign | string | For transit legs, the headsign of the bus or train being used. For non-transit legs, null. |
| agencyId | string | For transit legs, the ID of the transit agency that operates the service used for this leg. For non-transit legs, null. |
| tripId | string | For transit legs, the ID of the trip. For non-transit legs, null. |
| routeShortName | string | (no documentation provided) |
| routeLongName | string | (no documentation provided) |
| boardRule | string | (no documentation provided) |
| alightRule | string | (no documentation provided) |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| startTime (dateTime) | 0/1 | The date and time this leg begins. |
| endTime (dateTime) | 0/1 | The date and time this leg ends. |
| distance (double) | 0/1 | The distance traveled while traversing the leg in meters. |
| from (place) | 0/1 | The Place where the leg originates. |
| to (place) | 0/1 | The Place where the leg begins. |
| intermediateStops/stop (place) | 0/unbounded | For transit legs, intermediate stops between the Place where the leg originates and the Place where the leg ends. For non-transit legs, null. This field is optional i.e. it is always null unless "showIntermediateStops" parameter is set to "true" in the planner request. |
| legGeometry (encodedPolylineBean) | 0/1 | The leg's geometry. |
| steps/walkSteps (walkStep) | 0/unbounded | A series of turn by turn instructions used for walking, biking and driving. |
| notes (note) | 0/unbounded | Deprecated field formerly used for notes -- will be removed. See alerts |
| alerts (alert) | 0/unbounded | (no documentation provided) |
| duration (long) | 1/1 | The leg's duration in milliseconds |
Type lineString
- Extends: geometry
Type mapType
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| entry (entry) | 1/unbounded | (no documentation provided) |
Type modeList
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| modes/modes (TraverseMode) | 0/unbounded | (no documentation provided) |
Type money
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| cents (int) | 1/1 | (no documentation provided) |
| currency (wrappedCurrency) | 0/1 | (no documentation provided) |
Type note
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| text (string) | 0/1 | (no documentation provided) |
Type patchCreationResponse
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| status (string) | 0/1 | (no documentation provided) |
Type patchResponse
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| patches/AlertPatch (alertPatch) | 0/unbounded | (no documentation provided) |
Type patchSet
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| AlertPatch (alertPatch) | 0/unbounded | (no documentation provided) |
Type place
A Place is where a journey starts or ends, or a transit stop along the way.
Attributes
| name | type | description |
|---|---|---|
| orig | string | (no documentation provided) |
| zoneId | string | (no documentation provided) |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| name (string) | 0/1 | For transit stops, the name of the stop. For points of interest, the name of the POI. |
| stopId (agencyAndId) | 0/1 | The ID of the stop. This is often something that users don't care about. |
| stopCode (string) | 0/1 | The "code" of the stop. Depending on the transit agency, this is often something that users care about. |
| lon (double) | 0/1 | The longitude of the place. |
| lat (double) | 0/1 | The latitude of the place. |
| arrival (dateTime) | 0/1 | The time the rider will arrive at the place. |
| departure (dateTime) | 0/1 | The time the rider will depart the place. |
Type plannerError
This represents an error in trip planning.
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| id (int) | 1/1 | (no documentation provided) |
| missing (string) | 0/unbounded | (no documentation provided) |
| noPath (boolean) | 1/1 | (no documentation provided) |
Type relativeDirection
Represents a turn direction, relative to the current heading. CIRCLE_CLOCKWISE and CIRCLE_CLOCKWISE are used to represent traffic circles.
Possible Values
| value | description |
|---|---|
| HARD_LEFT | |
| LEFT | |
| SLIGHTLY_LEFT | |
| CONTINUE | |
| SLIGHTLY_RIGHT | |
| RIGHT | |
| HARD_RIGHT | |
| CIRCLE_CLOCKWISE | |
| CIRCLE_COUNTERCLOCKWISE | |
| ELEVATOR |
Type response
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| requestParameters () | 0/1 | A dictionary of the parameters provided in the request that triggered this response. |
| plan (tripPlan) | 0/1 | The actual trip plan. |
| error (plannerError) | 0/1 | The error (if any) that this response raised. |
Type routeData
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| id (agencyAndIdType) | 0/1 | (no documentation provided) |
| variants/variants (routeVariant) | 0/unbounded | (no documentation provided) |
| directions/directions (string) | 0/unbounded | (no documentation provided) |
Type routeList
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| route (transitRoute) | 0/unbounded | (no documentation provided) |
Type routeVariant
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| direction (string) | 0/1 | (no documentation provided) |
| name (string) | 0/1 | (no documentation provided) |
| trips (agencyAndIdType) | 0/1 | (no documentation provided) |
| stops (agencyAndIdType) | 0/1 | (no documentation provided) |
| geometry (lineString) | 0/1 | (no documentation provided) |
Type stop
Attributes
| name | type | description |
|---|---|---|
| lon | double | (no documentation provided) |
| lat | double | (no documentation provided) |
| stopCode | string | (no documentation provided) |
| stopName | string | (no documentation provided) |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| id (agencyAndIdType) | 0/1 | (no documentation provided) |
| route (agencyAndId) | 0/unbounded | (no documentation provided) |
Type stopList
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| stop (stop) | 0/unbounded | (no documentation provided) |
Type stopTime
Attributes
| name | type | description |
|---|---|---|
| time | long | These are departure times, except where the stop is the last stop on a particular trip, in which case they are arrivals |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| trip (agencyAndIdType) | 0/1 | (no documentation provided) |
| stop (agencyAndIdType) | 0/1 | (no documentation provided) |
Type stopTimeList
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| stopTime (stopTime) | 0/unbounded | (no documentation provided) |
Type transitError
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| message (string) | 0/1 | (no documentation provided) |
Type transitRoute
Attributes
| name | type | description |
|---|---|---|
| routeShortName | string | (no documentation provided) |
| routeLongName | string | (no documentation provided) |
| routeName | string | (no documentation provided) |
| url | string | (no documentation provided) |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| id (agencyAndIdType) | 0/1 | (no documentation provided) |
Type translatedString
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| translations (mapType) | 0/1 | (no documentation provided) |
Type TraverseMode
Possible Values
| value | description |
|---|---|
| WALK | |
| BICYCLE | |
| CAR | |
| TRAM | |
| SUBWAY | |
| RAIL | |
| BUS | |
| FERRY | |
| CABLE_CAR | |
| GONDOLA | |
| FUNICULAR | |
| TRANSIT | |
| TRAINISH | |
| BUSISH | |
| BOARDING | |
| ALIGHTING | |
| TRANSFER | |
| STL |
Type tripPlan
A TripPlan is a set of ways to get from point A to point B at time T.
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| date (dateTime) | 0/1 | The time and date of travel |
| from (place) | 0/1 | The origin |
| to (place) | 0/1 | The destination |
| itineraries/itinerary (itinerary) | 0/unbounded | A list of possible itineraries. |
Type walkStep
Represents one instruction in walking directions. Three examples from New York City:
Turn onto Broadway from W 57th St (coming from 7th Ave):
distance = 100 (say)
walkDirection = RIGHT
streetName = Broadway
everything else null/false
Now, turn from Broadway onto Central Park S via Columbus Circle
distance = 200 (say)
walkDirection = CIRCLE_COUNTERCLOCKWISE
streetName = Central Park S
exit = 1 (first exit)
immediately everything else false
Instead, go through the circle to continue on Broadway
distance = 100 (say)
walkDirection = CIRCLE_COUNTERCLOCKWISE
streetName = Broadway
exit = 3
stayOn = true
everything else false
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| distance (double) | 1/1 | The distance in meters that this step takes. |
| relativeDirection (relativeDirection) | 0/1 | The relative direction of this step. |
| streetName (string) | 0/1 | The name of the street. |
| absoluteDirection (absoluteDirection) | 0/1 | The absolute direction of this step. |
| exit (string) | 0/1 | When exiting a highway or traffic circle, the exit name/number. |
| stayOn (boolean) | 0/1 | Indicates whether or not a street changes direction at an intersection. |
| bogusName (boolean) | 0/1 | The name of this street was generated by the system, so we should only display it once, and generally just display right/left directions |
| lon (double) | 1/1 | The longitude of start of the step |
| lat (double) | 1/1 | The latitude of start of the step |
| elevation (string) | 0/1 | The elevation profile as a comma-separated list of x,y values. x is the distance from the start of the step, y is the elevation at this distance. |
| alerts (alert) | 0/unbounded | (no documentation provided) |