511DFW Public XML Web Services API Documentation
Introduction
Welcome to the 511DFW Public XML Web Services API
Documentation. The 511DFW XML data feeds provide real-time information about
transportation conditions and services in the DFW area in an easy-to-use XML
format for third party developers to use with their own sites, services, and
applications. The data feeds contain the same information as seen on the
511DFW website (www.511dfw.org). The
following describes how to access the various data types:
-
Real-Time CCTV (Closed Circuit TV) feeds
-
Real-Time DMS messages
-
Real-Time Event Data
-
Real-Time Parking Lot Occupancy
-
Real-Time Transit Predictions
-
Transit Route Data
-
Transit Stop Location Data
-
Real-Time Transit Vehicle Location and Occupancy Data
-
Real-Time Weather Alerts
-
Real-Time Weather Forecast Data
Obtaining Credentials and Logging-in
The 511DFW Public XML Web Services are available via HTTP connection, after you
request access via the Online Registration Form,
and receive a user name and password from the 511DFW Help Desk support team.
Validating Your User Account
In order to obtain XML data, the user account must be validated using the getAuthenticationToken()
method. The 511DFW Public Web Services getAuthenticationToken() request requires a 256 bit AES
encryption key and an encrypted string to authenticate with the server. When you signed up for your account, you should have
been provided with sample code to perform the getAuthenticationToken() request. If not, please
let us know and we will provide the sample source.
Upon sucessful validation, an encrypted authentication token will be returned and will
need to be passed to the desired web method. Authentication tokens will expire and will need to be requested again.
For automated log-ins the username and password should be sent via HTTP Web Request.
If you are pulling the XML for a web or windows application, obtaining
the XML data requires a call to the desired web method (detailed below) via HTTP Web Request with an authentication token.
The specific parameters to pass to the getAuthenticationToken() web method are: (parameters are case sensitive)
The data is returned in the following format.
|
<AuthenticationResponse>
<Status>SUCCESS</Status>
<Token>WmVTDvh69kWxFP90Y7vs0vAv3TZ49slKi3NYac EtDBQvvilkIZSt6HGaD/tnqyjb3dOYp0kpzA1sOIYNInzJrg==</Token>
</AuthenticationResponse>
|
Questions about the 511DFW Public XML Data Feed should be sent to the 511DFW
Feedback Team.
Real-Time CCTV (Closed Circuit TV) feeds
CCTV related data can be accessed from
https://webservices.511dfw.org/DFW511/PublicWebServices/DFW511_WebServices.asmx
and the web method to use is getCCTVs().
In order to obtain CCTV data, the following data elements are required:
- Token: Obtained from making a successful request to getAuthenticationToken() with your username and password.
Each CCTV element contains information as described below. To assist with programming, an
XSD document has been provided.
The data is returned in the following format. Please note, as described in the XSD, not all XML elements are required
and will not be provided in the response if the values are empty.
|
<CCTVs>
<CCTV>
<CCTV_ID>5074100</CCTV_ID>
<CCTV_NAME>SH183 @ Esters</CCTV_NAME>
<NATIVE_CCTV_ID>SH183 @ Esters</NATIVE_CCTV_ID>
<OWNER_NAME>TxDOT Dallas</OWNER_NAME>
<DESCRIPTION>SH183 @ Esters</DESCRIPTION>
<DIRECTION>3</DIRECTION>
<LOCATION>SH183 @ Esters</LOCATION>
<STATE>TX</STATE>
<LATITUDE>32.83646</LATITUDE>
<LONGITUDE>-97.00938</LONGITUDE>
<STATUS>3</STATUS>
<URL>http://ppweb.511dfw.org/snapshots/C2C_5074100.jpg</URL>
<LASTUPDATED>9/29/2017 9:22:27 AM</LASTUPDATED>
<CCTV>
...
</CCTV>
</CCTVs>
|
The following are details on the data elements:
|
Attribute
|
Type
|
Description
|
|
CCTV_ID
|
string
|
Unique identifier.
|
|
CCTV_Name
|
string
|
Text based identifier
|
|
Native_CCTV_ID
|
string
|
Native identifier from agency controlling the camera
|
|
Owner_Name
|
string
|
Agency owner controlling the camera.
|
|
Description
|
string
|
Description
|
|
Direction
|
integer
|
Direction camera is facing
|
|
Location
|
string
|
Descriptive Location
|
|
State
|
string
|
State
|
|
Latitude
|
Float
|
CCTV Geographic coordinates in decimal degrees
|
|
Longitude
|
Float
|
CCTV Geographic coordinates in decimal degrees
|
|
Status
|
integer
|
See Status scalar below
|
|
URL
|
string
|
URL of motion or image based feed
|
|
LastUpdated
|
datetime
|
Last Status update
|
Real-Time DMS messages
Real-Time DMS messages can be accessed from
https://webservices.511dfw.org/DFW511/PublicWebServices/DFW511_WebServices.asmx
and the web method to use is getDMS().
In order to obtain DMS data, the following data elements are required:
- Token: Obtained from making a successful request to getAuthenticationToken() with your username and password.
Each DMS element contains information as described below. To assist with programming, an XSD document
has been provided.
The data is returned in the following format.
|
<DMSs>
<DMS>
<DMS lon ="-96.850204" lat="32.64434" owner_name="TXDOT18" location="IH20 EB Hampton" name="IH20 EB Hampton" id="55">
<MESSAGE></MESSAGE>
<LAST_UPDATE>7/17/2012 3:34:48 PM</LAST_UPDATE>
<STATUS/>Unknown</STATUS>
</DMS>
<DMS>
...
</DMS>
</DMS>
|
The following are details on the data elements:
|
Attribute
|
Type
|
Description
|
|
Lon
|
Float
|
DMS Geographic coordinates in decimal degrees
|
|
Lat
|
Float
|
DMS Geographic coordinates in decimal degrees
|
|
Owner_Name
|
string
|
Agency controlling sign
|
|
Location
|
string
|
Descriptive location
|
|
Name
|
string
|
Text based identifier
|
|
ID
|
integer
|
Unique identifier
|
Real-Time Event Data
Real-Time Event data can be accessed from
https://webservices.511dfw.org/DFW511/PublicWebServices/DFW511_WebServices.asmx and the web method to use is getEvents().
In order to obtain Event data, the following data elements are required:
- Token: Obtained from making a successful request to getAuthenticationToken() with your username and password.
Each Event element contains information as described below. To assist with programming, an
XSD document has been provided.
The data is returned in the following format. Please note, as described in the XSD, not all XML elements are required
and will not be provided in the response if the values are empty.
|
<EVENTS>
<EVENT>
<EVENT_ID>2017081318090605074</EVENT_ID>
<EVENT_STATE>6</EVENT_STATE>
<EVENT_CLASS>5</EVENT_CLASS>
<EVENT_TYPE>construction</EVENT_TYPE>
<REPORT_ORG_ID>5074</REPORT_ORG_ID>
<FACILITY_ID>1021</FACILITY_ID>
<FACILITY_NAME>SH 183 Eastbound</FACILITY_NAME>
<DIRECTION>Eastbound</DIRECTION>
<ARTICLE_CODE>BETWEEN</ARTICLE_CODE>
<FROM_POINT_ID>10211050</FROM_POINT_ID>
<FROM_LOC_POINT>Valley View Ln</FROM_LOC_POINT>
<TO_POINT_ID>10211180</TO_POINT_ID>
<TO_LOC_POINT>Spur 482</TO_LOC_POINT>
<CREATE_TIME>8/13/2017 6:09:06 PM</CREATE_TIME>
<LAST_UPDATE>8/13/2017 6:09:06 PM</LAST_UPDATE>
<EVENT_DESCRIPTION>TxDOT Dallas: construction on SH 183 Eastbound between Valley View Ln and Spur 482, 2/23/2017 9:00:00 PM through 12/1/2017 6:00:00 AM. ONGOING-NITE EXC HOLIDAYS</EVENT_DESCRIPTION>
<CITY>Irving</CITY>
<COUNTY>Dallas</COUNTY>
<STATE>TX</STATE>
<EST_DURATION>9460254</EST_DURATION>
<LAT>32.836838</LAT>
<LON>-97.021986</LON>
<TO_LAT>32.835583</TO_LAT>
<TO_LON>-96.900259</TO_LON>
<LANES_AFFECTED>0</LANES_AFFECTED>
<LANE_STATUS>closed</LANE_STATUS>
<TOTAL_LANES>0</TOTAL_LANES>
<LANE_DESCRIPTION>various lanes</LANE_DESCRIPTION>
<UPDATE_NUMBER>0</UPDATE_NUMBER>
<RESPOND_ORG_NAME>DART</RESPOND_ORG_NAME>
<START_DATE>2/23/2017 9:00:00 PM</START_DATE>
<END_DATE>12/1/2017 6:00:00 AM</END_DATE>
<SCHEDULES>
<SCHEDULE>
<SCHEDULE_ID>1</SCHEDULE_ID>
<SCHEDULE_START>2/23/2017 9:00:00 PM</SCHEDULE_START>
<SCHEDULE_END>12/1/2017 6:00:00 AM</SCHEDULE_END>
<LANE_DESCRIPTION>various lanes</LANE_DESCRIPTION>
<TOTAL_LANES>0</TOTAL_LANES>
<LANES_AFFECTED>0</LANES_AFFECTED>
<LANE_STATUS>closed</LANE_STATUS>
<ALT_ROUTE_DELAYS>0</ALT_ROUTE_DELAYS>
<FACILITY_DELAYS>0</FACILITY_DELAYS>
<CONTINUOUS_FLAG>false</CONTINUOUS_FLAG>
<MSG_SENT_FLAG>false</MSG_SENT_FLAG>
<STATUS>1</STATUS>
<ACTIVATE_FLAG>true</ACTIVATE_FLAG>
<SCHEDULE_START_FLAG>false</SCHEDULE_START_FLAG>
<PAST_EVENT_ACTIVATE>false</PAST_EVENT_ACTIVATE>
</SCHEDULE>
</SCHEDULES>
<ACTIONS>
<ACTION>
<ACTION_ID>1</ACTION_ID>
<ACTION_TIME_DATE>8/13/2017 6:09:06 PM</ACTION_TIME_DATE>
<ACTION_TEXT>construction Reported by: DART</ACTION_TEXT>
<ACTION_TYPE>NEW</ACTION_TYPE>
<ORD_ID>5074</ORG_ID>
<EVENT_STATE>6</EVENT_STATE>
</ACTION>
</ACTIONS>
<EVENT>
...
</EVENT>
</EVENTS>
|
The following are details on the data elements:
|
Attribute
|
Type
|
Description of the Transit Event
|
|
Event_ID
|
integer
|
Unique identifier
|
|
Event_State
|
integer
|
State of event (new, update, close)
|
|
Event_class
|
integer
|
Class of event
|
|
Event_Type
|
string
|
Type of event
|
|
Report_Org_Id
|
integer
|
Identifier of Agency entering event in system
|
|
Facility_ID
|
integer
|
ID of facility affected
|
|
Facility_Name
|
string
|
Name of facility affected
|
|
Direction
|
string
|
Direction of Travel
|
|
Article_Code
|
string
|
Qualifier text (at, near)
|
|
From_Point_ID
|
integer
|
Point id where event is located or starts
|
|
From_Loc_Point
|
string
|
Textual location description of point where event is located or starts
|
|
To_Point_ID
|
integer
|
Point id of extent of events affected
|
|
To_Loc_point
|
string
|
Textual location description of extent of events affect
|
|
Create_time
|
datetime
|
Date and Time of event created in system
|
|
Last_update
|
datetime
|
Date and Time of last event update in system
|
|
Event Description
|
string
|
Event description
|
|
City
|
string
|
City name
|
|
County
|
string
|
County name
|
|
State
|
string
|
2 digit state abbreviation
|
|
Est_Duration
|
integer
|
Estimated duration of event (in seconds)
|
|
Lat
|
dfloat
|
Transit Event Geographic coordinates in decimal degrees
|
|
Lon
|
float
|
Transit Event Geographic coordinates in decimal degrees
|
|
To_Lat
|
double
|
Event Extent Location - Latitude Geographic coordinates in decimal degrees for To point
|
|
To_Lon
|
double
|
Event Extent Location - Longitude Geographic coordinates in decimal degrees for To point
|
|
Lanes_Affected
|
integer
|
Number of lanes affected by event
|
|
Lane_Status
|
text
|
Text based identifier for lane status.
|
|
Total_Lanes
|
integer
|
Number of total lanes
|
|
Lane_Description
|
text
|
Textual description of current affected lane(s) (including lane type(s)) and associated status(es)
|
|
Update_Number
|
integer
|
The amount of times the event has updated
|
|
Respond_Org_Name
|
string
|
Identifier of agency responding to event
|
|
Start_Date
|
datetime
|
Start date of event
|
|
End_Date
|
datetime
|
End date of event
|
|
Schedule_Id
|
integer
|
Unique schedule identifier
|
|
Schedule_Start
|
datetime
|
Expected start of schedule
|
|
Schedule_End
|
datetime
|
Expected end of schedule
|
|
Lane_Description
|
datetime
|
Last Status update
|
|
Total_Lanes
|
integer
|
Total lane capacity
|
|
Lanes_Affected
|
integer
|
Number of lanes affected by event
|
|
Lane_Status
|
datetime
|
Last Status update
|
|
Alt_Route_Delays
|
datetime
|
Last Status update
|
|
Facility_Delays
|
datetime
|
Last Status update
|
|
Continuous_Flag
|
Bit
|
True if continuous between start and end date/time
|
|
Msg_Sent_Flag
|
Bit
|
True if message has been sent
|
|
Status
|
integer
|
Value signifying if transit event is active
|
|
Activate_Flag
|
Bit
|
True if schedule will auto-activate
|
|
Schedule_Start_Flag
|
Bit
|
True if there is a scheduled start flag date
|
|
Past_event_Activate
|
datetime
|
Last Status update
|
|
Action_Id
|
integer
|
Unique identifier
|
|
Action_Time_Date
|
datetime
|
Date and Time of entry
|
|
Action_text
|
string
|
Textual description of action
|
|
Action_Type
|
nvarchar
|
Last Status update
|
|
Org_Id
|
integer
|
Agency identifier
|
Real-Time Parking Lot Occupancy feeds
Parking Lot related data can be accessed from
https://webservices.511dfw.org/DFW511/PublicWebServices/DFW511_WebServices.asmx and the web method to use is getParkingLotData().
In order to obtain Parking Lot data, the following data elements are required:
- Token: Obtained from making a successful request to getAuthenticationToken() with your username and password.
Each parking lot element contains information as described below. To assist with programming, an
XSD document has been provided.
The data is returned in the following format. Please note, as described in the XSD, not all XML elements are required
and will not be provided in the response if the values are empty.
|
<PARKING_STATIONS>
<PARKING_STATION>
<PARKING_STATION_ID1</PARKING_STATION_ID>
<PARKING_STATION_NAME>Parker Station</PARKING_STATION_NAME>
<PARKING_STATION_ADDRESS>2600 ARCHERWOOD ST. PLANO, Texas</PARKING_STATION_ADDRESS>
<LATITUDE>33.03641</LATITUDE>
<LONGITUDE>-96.70192</LONGITUDE>
<PARKING_LOTS>
<PARKING_LOT>
<PARKING_LOT_ID>1</PARKING_LOT_ID>
<PARKING_LOT_NAME>Lot A</PARKING_LOT_NAME>
<CAPACITY>828</CAPACITY>
<UTILIZATION>9</UTILIZATION>
<AVAILABILITY>819</AVAILABILITY>
<LAST_UPDATED_REC>10/2/2017 2:00:05 AM</LAST_UPDATED_REC>
</PARKING_LOT>
<PARKING_LOT>
<PARKING_LOT_ID>2</PARKING_LOT_ID>
<PARKING_LOT_NAME>Lot B</PARKING_LOT_NAME>
<CAPACITY>28</CAPACITY>
<UTILIZATION>27</UTILIZATION>
<AVAILABILITY>1</AVAILABILITY>
<LAST_UPDATED_REC>10/2/2017 9:31:36 AM</LAST_UPDATED_REC>
</PARKING_LOT>
<PARKING_LOT>
<PARKING_LOT_ID>3</PARKING_LOT_ID>
<PARKING_LOT_NAME>Lot C</PARKING_LOT_NAME>
<CAPACITY>377</CAPACITY>
<UTILIZATION>353</UTILIZATION>
<AVAILABILITY>24</AVAILABILITY>
<LAST_UPDATED_REC>10/2/2017 9:35:34 AM</LAST_UPDATED_REC>
</PARKING_LOT>
<PARKING_LOT>
<PARKING_LOT_ID>4</PARKING_LOT_ID>
<PARKING_LOT_NAME>Lot D</PARKING_LOT_NAME>
<CAPACITY>258</CAPACITY>
<UTILIZATION>24</UTILIZATION>
<AVAILABILITY>234</AVAILABILITY>
<LAST_UPDATED_REC>10/2/2017 8:57:32 AM</LAST_UPDATED_REC>
</PARKING_LOT>
<PARKING_LOT>
<PARKING_LOT_ID>5</PARKING_LOT_ID>
<PARKING_LOT_NAME>Lot E</PARKING_LOT_NAME>
<CAPACITY>568</CAPACITY>
<UTILIZATION>306</UTILIZATION>
<AVAILABILITY>262</AVAILABILITY>
<LAST_UPDATED_REC>10/2/2017 9:35:40 AM</LAST_UPDATED_REC>
</PARKING_LOT>
<PARKING_LOTS>
...
</PARKING_STATION>
</PARKING_STATIONS>
|
The following are details on the data elements:
|
Attribute
|
Type
|
Description
|
|
Parking_Station_ID
|
integer
|
Unique identifier.
|
|
Parking_Station_Name
|
string
|
Text based identifier
|
|
Parking_Station_Address
|
string
|
Text based Identifiter
|
|
Latitude
|
float
|
Parking Lot Geographic coordinates in decimal degrees
|
|
Longitude
|
string
|
Parking Lot Geographic coordinates in decimal degrees
|
|
Parking_Lot_Id
|
integer
|
Unique Identifier
|
|
Parking_Lot_Name
|
string
|
Text based identifier
|
|
Capacity
|
integer
|
Maximum allotted space available
|
|
Utilization
|
integer
|
Spots currently occupied
|
|
Availability
|
Integer
|
Spots that are available
|
|
Last_Updated_rec
|
string
|
Last updated time stamp for parking lot
|
Real-Time Transit Predictions
Real-Time Transit Prediction data can be accessed from
https://webservices.511dfw.org/DFW511/PublicWebServices/DFW511_WebServices.asmx
and the web method to use is getTransitPredictions().
In order to get your transit predictions, the following data elements are required:
- Token: Obtained from making a successful request to getAuthenticationToken() with your username and password.
- PassedRoute: Obtained from the getTransitRoutes() method <predictions-rt-nm> element. Example: RED-DART Rail - RED LINE.
- PassedStop: Obtained from the getTransitStops() method <stpnm> element and passing in the <rt> element from getTransitRoutes(). Example: CITYPLACE-UPTOWN STATION.
- PassedDirection: Obtained from the getTransitRoutes() method <direction> element. Example: northbound.
To obtain successful transit predictions, values for PassedRoute and PassedDirection should be obtained from the getTransitRoutes() method.
Route name should be collected from the "predictions-rt-nm" element and direction should be obtained from the "direction" element from getTransitRoutes().
Values for the PassedStop should be collected using <stpnm> element from getTransitStops() method and passing the <rt> element from getTransitRoutes().
For example, the following request parameters can be used to request a transit predictions response:
- Token: Your token
- PassedRoute: Example: RED-DART Rail - RED LINE.
- PassedStop: Example: CITYPLACE-UPTOWN STATION.
- PassedDirection: Example: northbound.
Each transit prediction element contains information as described below. To assist with programming, an
XSD document has been provided.
The data is returned in the following format:
|
<TravelerInformationResponse>
<responseType>
<routes>
<transitRoute>
<transitRouteLegInformation>
<route-Name>red-dart rail - red line | northbound:northbound</route-Name>
<originStop>
<cPT-StopPointID>26420</cPT-StopPointID>
<cPT-StopPointName>cityplace-uptown station</cPT-StopPointName>
</originStop>
<nearestAvailableTime>
<pI-DepartTimeEstimated>2017-09-28T11:23:00.872-0500</pI-DepartTimeEstimated>
</nearestAvailableTime>
</transitRouteLegInformation>
<transitRouteLegInformation>
<route-Name>red-dart rail - red line | northbound:northbound</route-Name>
<originStop>
<cPT-StopPointID>26420</cPT-StopPointID>
<cPT-StopPointName>cityplace-uptown station</cPT-StopPointName>
<originStop>
<nearestAvailableTime>
<pI-DepartTimeEstimated>2017-09-28T11:23:00.872-0500</pI-DepartTimeEstimated>
</nearestAvailableTime>
</transitRouteLegInformation>
<transitRouteLegInformation>
<route-Name>red-dart rail - red line | northbound:northbound</route-Name>
<originStop>
<cPT-StopPointID>26420</cPT-StopPointID>
<cPT-StopPointName>cityplace-uptown station</cPT-StopPointName>
<originStop>
<nearestAvailableTime>
<pI-DepartTimeEstimated>2017-09-28T11:23:00.872-0500</pI-DepartTimeEstimated>
</nearestAvailableTime>
</transitRouteLegInformation>
<last-UpdateTime>2017-09-28T11:20:58.000+0800</last-UpdateTime>
<arrivalTimeReportType>TimeOfDay</arrivalTimeReportType>
<max-NumberOfPredictions>6</max-NumberOfPredictions>
<transitRoute>
<routes>
</responseType>
<responseType>
...
</responseType>
</TravelerInformationResponse>
|
The following are details on the data elements:
|
Attribute
|
Type
|
Description
|
|
Route-Name
|
Text
|
Text based identifier for Route-Name
|
|
cPT-StopPointID
|
Integer
|
Unique Stop Point identifier
|
|
cPT-StopPointName
|
Text
|
Text based identifier for the Route stop
|
|
pI-DepartTimeEstimated
|
datetime
|
Most recent date/time for prediction.
|
|
last-UpdateTime
|
datetime
|
Last updated time for transit routes.
|
|
arrivalTimeReportType
|
string
|
How the arrival time is reported.
|
|
max-NumberOfPredictions
|
integer
|
Maximum number of route predictions.
|
Transit Route Data
Transit Route data can be accessed from
https://webservices.511dfw.org/DFW511/PublicWebServices/DFW511_WebServices.asmx
and the web method to use is getTransitRoutes().
In order to obtain Transit Route data, the following data elements are required:
- Token: Obtained from making a successful request to getAuthenticationToken() with your username and password.
Each transit route element contains information as described below. To assist with programming, an
XSD document has been provided.
The data is returned in the following format:
|
<bustime-response>
<route>
<rt_id>1</rt_id>
<rt>001</rt>
<rtnm>WYNNEWOOD/MOCKINGBIRD STATION</rtnm>
<predictions-rt-nm>001-WYNNEWOOD-MOCKINGBIRD STATION</predictions-rt-nm>
<direction>northbound</direction>
<route-type>3</route-type>
</route>
<route>
...
</route>
</bustime-response>
|
The following are details on the data elements:
|
Attribute
|
Type
|
Description
|
|
rt_id
|
integer
|
Unique route identifier
|
|
rt
|
string
|
Internal, unique code of route formatted as: Route ModeRoute Number-Direction
|
|
rtnm
|
text
|
Route name identifier
|
|
predictions-rt-nm
|
float
|
Most recent vehicle latitude coordinate value.
|
|
direction
|
text
|
Route Direction
|
|
route-type
|
datetime
|
Previous date/time of vehicle location and occupancy.
|
Transit Stop Location Data
Transit stop location data can be accessed from
https://webservices.511dfw.org/DFW511/PublicWebServices/DFW511_WebServices.asmx
and the web method to use is getTransitStops().
In order to obtain Transit Stop data, the following data elements are required:
- Token: Obtained from making a successful request to getAuthenticationToken() with your username and password.
- PassedRoute: Obtained from the getTransitRoutes() method <rt></rt> element. Example: RED.
Each transit stop element contains information as described below. To assist with programming, an
XSD document has been provided.
The data is returned in the following format:
|
<bustime-response>
<stop>
<stpid>15913</stpid>
<stpnm>WESTMORELAND</stpnm>
<lat>32.719759</lat>
<lon>-96.872207</lon>
<rt>-96.70192</rt>
<rtnm>NULL</rtnm>
<direction>9/22/2014 7:03:41 PM</direction>
</stop>
<stop>
...
</stop>
</bustime-response>
|
The following are details on the data elements:
|
Attribute
|
Type
|
Description
|
|
stpid
|
integer
|
Unique vehicle ID.
|
|
stpnm
|
string
|
Name of the stop
|
|
lat
|
float
|
Geographic longitude coordinate of a stop in decimal degrees.
|
|
lon
|
float
|
Geographic longitude coordinate of a stop in decimal degrees
|
|
rt
|
string
|
Internal, unique code of route formatted as: Route ModeRoute Number-Direction
|
|
rtnm
|
string
|
Route name identifier
|
|
direction
|
string
|
Route Direction
|
Real-Time Transit Vehicle Location and Occupancy Data
Real-Time Transit Vehicle Location and Occupancy data can be accessed from
https://webservices.511dfw.org/DFW511/PublicWebServices/DFW511_WebServices.asmx and the web method to use is getTransitVehicleLocation().
In order to obtain Transit Vehicle Location data, the following data elements are required:
- Token: Obtained from making a successful request to getAuthenticationToken() with your username and password.
Each transit vehicle element contains information as described below. To assist with programming, an
XSD document has been provided.
The data is returned in the following format:
|
<transitVehicleLocations>
<transitVehicleLocation>
<vehicle_id>4868</vehicle_id>
<route_type>3</route_type>
<evt_date>9/22/2014 7:05:41 PM</evt_date>
<latitude>33.03641</latitude>
<longitude>-96.70192</longitude>
<location>NULL</location>
<prev_evt_date>9/22/2014 7:03:41 PM</prev_evt_date>
<prev_latitude>33.03641</prev_latitude>
<prev_longitude>-96.70192</prev_longitude>
<blocknum>104</blocknum>
<line>1</line>
<pattern>NULL</pattern>
<last_timept>NULL</last_timept>
<next_timept>NULL</next_timept>
<occupancy>15</occupancy>
<num_block_parts>NULL</num_block_parts>
<SystemCollectionDt>9/22/2014 7:16:36 PM</ SystemCollectionDt>
</transitVehicleLocation>
<transitVehicleLocation>
...
</transitVehicleLocation>
</transitVehicleLocations>
|
The following are details on the data elements:
|
Attribute
|
Type
|
Description
|
|
vehicle_id
|
integer
|
Unique vehicle ID.
|
|
route_type
|
integer
|
The route_type field describes the type of transportation used on a route.Valid values for this field are:
- Tram, Streetcar, Light rail. Any light rail or street level system within a metropolitan area.
- Subway, Metro. Any underground rail system within a metropolitan area.
- Rail. Used for intercity or long-distance travel.
- Bus. Used for short- and long-distance bus routes.
- Ferry. Used for short- and long-distance boat service.
- Cable car. Used for street-level cable cars where the cable runs beneath the car.
- Gondola, Suspended cable car. Typically used for aerial cable cars where the car is suspended from the cable.
- Funicular. Any rail system designed for steep inclines.
|
|
evt_date
|
datetime
|
Most recent date/time of vehicle location and occupancy.
|
|
latitude
|
float
|
Most recent vehicle latitude coordinate value.
|
|
longitude
|
float
|
Most recent vehicle longitude coordinate value.
|
|
location
|
string
|
Location of transit vehicle.
|
|
prev_evt_date
|
datetime
|
Previous date/time of vehicle location and occupancy.
|
|
prev_latitude
|
float
|
Previous vehicle latitude coordinate value.
|
|
prev_longitude
|
float
|
Previous vehicle longitude coordinate value.
|
|
blocknum
|
integer
|
The block_id field identifies the block to which the trip belongs. A block consists of two or more sequential
trips made using the same vehicle, where a passenger can transfer from one trip to the next just by staying in the vehicle.
|
|
line
|
String
|
Transit line of vehicle.
|
|
pattern
|
string
|
Current Route Pattern.
|
|
last_timept
|
string
|
Last timepoint name.
|
|
next_timept
|
string
|
Next timepoint name.
|
|
occupancy
|
integer
|
Transit vehicle occupancy represented in percentage.
|
|
num_block_parts
|
integer
|
Refers to the number of cars coupled together to form a train, or, consist.
|
|
SystemCollectionDt
|
datetime
|
Date and time the vehicle location and occupancy was last updated.
|
Real-Time Weather Forecast Data
Weather related data can be accessed from
https://webservices.511dfw.org/DFW511/PublicWebServices/DFW511_WebServices.asmx
and the web method to use is getWeatherData().
In order to obtain Weather Forecast data, the following data elements are required:
- Token: Obtained from making a successful request to getAuthenticationToken() with your username and password.
Each weather forecast element contains information as described below. To assist with programming, an
XSD document has been provided.
The data is returned in the following format. Please note, as described in the XSD, not all XML elements are required
and will not be provided in the response if the values are empty.
|
<WEATHERLOCATIONS>
<LOCATION>
<LOCATIONNAME>Collin</LOCATIONNAME>
<LATITUDE>33.1938849</LATITUDE>
<LONGITUDE>-96.5781527</LONGITUDE>
<PERIOD>
<POSITION>0</POSITION>
<PERIODNAME>Current</PERIODNAME>
<STARTTIME>10/2/2017 12:00:00 PM</STARTTIME>
<ENDTIME>10/2/2017 12:00:00 PM</ENDTIME>
<TEMPTYPE>Current</TEMPTYPE>
<TEMPERATURE>82</TEMPERATURE>
<CONDITION>Partly Cloudy</CONDITION>
</PERIOD>
<LOCATION>
...
</LOCATION>
</WEATHERLOCATIONS>
|
The following are details on the data elements:
|
Attribute
|
Type
|
Description
|
|
LocationName
|
string
|
Text based identifier.
|
|
Latitude
|
float
|
Weather Geographic coordinates in decimal degrees
|
|
Longitude
|
float
|
Weather Geographic coordinates in decimal degrees
|
|
Position
|
integer
|
Current position for weather data
|
|
Description
|
string
|
Description
|
|
Direction
|
integer
|
Weather direction
|
|
Location
|
string
|
Descriptive Location
|
|
State
|
string
|
State
|
|
Latitude
|
Float
|
Weaher Geographic coordinates in decimal degrees
|
|
Longitude
|
Float
|
Weather Geographic coordinates in decimal degrees
|
|
Position
|
integer
|
Current of weather position.
|
|
PeriodName
|
string
|
Time of the week when weather forecast is reported
|
|
StartTime
|
datetime
|
Start time of weather forecast
|
|
EndTime
|
datetime
|
End time of weather forecast
|
|
TempType
|
string
|
Weather temperature status
|
|
Temperature
|
integer
|
Weather forecast temperature
|
|
Condition
|
text type
|
Current state of the weather
|