89° Weather Icon Partly Cloudy Weather Arrow  
  ABOUT | CONTACT | FAQ | FEEDBACK  
Hi,  you're in Dallas|  Sign In  My511 Login Arrow
     
 
 
 
 
 
My511 Signup
 
Forgot your password?
 
     
 
   
Alerts  
Forecast  
Radar Overlay  
   
 
ALERTS:

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:

  • DART Transit related Events
  • Real-Time Parking Lot Occupancy
  • Real-Time Transit Vehicle Location and Occupancy Data

 

Obtaining Credentials and Logging-in

 

This 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.

 

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 username and password. The specific parameters to pass to the service are: (parameters are case sensitive)

  • username
  • password


Questions about the 511DFW Public XML Data Feed should be sent to the 511DFW Feedback Team.



DART Transit related Events

DART Transit related Event data is accessed from http://4.31.137.82/DFW511/PublicWebServices/DFW511_WebServices.asmx and the web method to use is getEvents(). Each event 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. Closed events will remain in the response for two hours after being closed.

<EVENTS>
  <EVENT>
    <EVENT_ID>2014090303221207001</EVENT_ID>
    <EVENT_STATE>9</EVENT_STATE>
    <EVENT_CLASS>16</EVENT_CLASS>
    <EVENT_TYPE>bicycle event</EVENT_TYPE>
    <REPORT_ORG_ID>7001</REPORT_ORG_ID>
    <FACILITY_NAME>Bus 12</FACILITY_NAME>
    <DIRECTION>inbound</DIRECTION>
    <ARTICLE_CODE>between</ARTICLE_CODE>
    <FROM_LOC_POINT>Westmoreland Rd</FROM_LOC_POINT>
    <TO_LOC_POINT>2ND @ BERTRAND - N - FS</TO_LOC_POINT>
    <CREATE_TIME>9/3/2014 3:22:12 AM</CREATE_TIME>
    <LAST_UPDATE>9/22/2014 4:31:08 PM</LAST_UPDATE>
    <CLOSE_TIME>NULL</CLOSE_TIME>
    <EVENT_DESCRIPTION>DART: Due to bicycle event GLENN HEIGHTS 012-WESTMOUNT-HATCHER between 2ND @ HANCOCK - N - NS and 2ND @ BERTRAND - N - FS, Wednesday September 3rd, 2014, 04:21 AM</EVENT_DESCRIPTION>
    <CITY>Dallas</CITY>
    <COUNTY>Dallas</COUNTY>
    <STATE>TX</STATE>
    <EST_DURATION>0</EST_DURATION>
    <LAT>32.760731</LAT>
    <LON>-96.744118</LON>
    <TO_LAT>32.760731</TO_LAT>
    <TO_LON>-96.744118</TO_LON>
    <LANES_AFFECTED>0</LANES_AFFECTED>
    <LANE_STATUS>NULL</LANE_STATUS>
    <TOTAL_LANES>0</TOTAL_LANES>
    <LANE_DESCRIPTION>NULL</LANE_DESCRIPTION>
    <LANE_DETAIL>NULL</LANE_DETAIL>
    <UPDATE_NUMBER>2</UPDATE_NUMBER>
    <RESPOND_ORG_NAME>DART</RESPOND_ORG_NAME>
    <PAVEMENT_CONDITION>NULL</PAVEMENT_CONDITION>
    <WEATHER_CODITION>NULL</WEATHER_CODITION>
    <START_DATE>NULL</START_DATE>
    <END_DATE>NULL</END_DATE>
    <EVENT_OTHER_DESC>NULL</EVENT_OTHER_DESC>
    <FROM_MILE_MARKER>143.3</From_Mile_Marker>
    <TO_MILE_MARKER>141.2</To_Mile_Marker>
    <CONSTRUCTION_TYPE>NULL</CONSTRUCTION_TYPE>
    <PARENT_EVENT_ID>NULL</PARENT_EVENT_ID>
    <INCIDENT_IMPACT>NULL</INCIDENT_IMPACT>
    <SCHEDULES>
      <SCHEDULE>
        <SCHEDULE_ID>1</SCHEDULE_ID>
        <EVENT_ID>2014090303221207001</EVENT_ID>
        <DAY_OF_WEEK>Wed</DAY_OF_WEEK>
        <SCHEDULED_START>9/3/2014 4:21:00 AM</SCHEDULED_START>
        <SCHEDULED_END>9/4/2014 4:21:00 AM</SCHEDULED_END>
        <LANE_DESCRIPTION>NULL</LANE_DESCRIPTION>
        <TOTAL_LANES>0</TOTAL_LANES>
        <LANES_AFFECTED>0</LANES_AFFECTED>
        <LANE_DETAIL>NULL</LANE_DETAIL>
        <LANE_STATUS>NULL</LANE_STATUS>
        <ALT_ROUTE>NULL</ALT_ROUTE>
        <ALT_ROUTE_DELAYS>0</ALT_ROUTE_DELAYS>
        <FACILITY_DELAYS>0</FACILITY_DELAYS>
        <IMPACT>NULL</IMPACT>
        <TIME_OF_DAY>NULL</TIME_OF_DAY>
        <STATUS>1</STATUS>
      </SCHEDULE>
      <SCHEDULE>
        ...
      </SCHEDULE>
    </SCHEDULES>
    <ACTIONS>
      <ACTION>
        <EVENT_ID>2014090303221207001</EVENT_ID>
        <ACTION_ID>1</ACTION_ID>
        <ACTION_TIME_DATE>9/3/2014 3:22:12 AM</ACTION_TIME_DATE>
        <ACTION_TEXT>bicycle event Reported by: DART</ACTION_TEXT>
        <ACTION_TYPE>NEW</ACTION_TYPE>
        <ORG_ID>7001</ORG_ID>
        <EVENT_STATE>9</EVENT_STATE>
        <CLOSE_TIME>NULL</CLOSE_TIME>
      </ACTION>
      <ACTION>
        ...
      </ACTION>
    </ACTIONS>
  </EVENT>
  <EVENT>
    ...
  </EVENT>
</EVENTS>

 


The following details are specifics of the Event data elements:

Attribute

Type

Description

EVENT_ID

string

Unique ID of the event (19 character string).

EVENT_STATE

string

Whether the event is in the opened, updated, or closed state.

Possible values are:
6: opened
9: updated
11: closed

EVENT_CLASS

string

General event type description. Possible values are:

1: incident
2: transit incident
3: active construction
4: transit active construction
5: construction
6: transit construction
7: special event
14: active special event
16: transit special event
17: transit active special event

EVENT_TYPE

string

Specific event type description.

REPORT_ORG_ID

string

Organization responsible for reporting the event.

FACILITY_NAME

string

Name of the facility affected by the event.

DIRECTION

string

Direction of traffic flow affected by the event.

ARTICLE_CODE

string

Descriptor corresponding to the from and to location. (ex. on, at, between)

FROM_LOC_POINT

string

Starting location of the event.

TO_LOC_POINT

string

Ending location of the event.

CREATE_TIME

datetime

Date and time the event was created.

LAST_UPDATE

datetime

Date and time the event was last updated.

CLOSE_TIME

datetime

Date and time the event was closed.

EVENT_DESCRIPTION

string

Full event description containing detailed event information.

CITY

string

City location of the event.

COUNTY

string

County location of the event.

STATE

string

State location of the event.

EST_DURATION

integer

Number in seconds that the event is expected to be active for. Estimated Duration of 0 denotes "until further notice."

LAT

float

Starting latitude location of the event (signed floating point number).

LON

float

Starting longitude location of the event (signed floating point number).

TO_LAT

float

Ending latitude location of the event (signed floating point number).

TO_LON

float

Ending longitude location of the event (signed floating point number).

LANES_AFFECTED

integer

Number of lanes affected by the event.

LANE_STATUS

string

Lane status descriptor (ex. closed, blocked).

TOTAL_LANES

integer

Total number of lanes affected by the event.

LANE_DESCRIPTION

string

Lane descriptor (ex. 1 lane may be, right lane and shoulder, left and center lanes).

LANE_DETAIL

string

Detailed lane description (ex. local lanes, local and express roadways, express lanes).

UPDATE_NUMBER

integer

Number of times the event has been updated.

RESPOND_ORG_NAME

string

Organization or application responsible for the event entry.

PAVEMENT_CONDITION

string

Condition of pavement where the event is located.

WEATHER_CODITION

string

Weather condition where the event is located.

START_DATE

datetime

Date and time the event is scheduled to begin.

END_DATE

datetime

Date and time the event is scheduled to close.

EVENT_OTHER_DESC

string

Other descriptive information about the event (ex. 15 minute delays, 2 mile delay).

FROM_MILE_MARKER

string

Starting milemarker affected by the event on the facility affected by the event.

TO_MILE_MARKER

string

Ending milemarker affected by the event on the facility affected by the event.

CONSTRUCTION_TYPE

string

(ex. C,E,M,O,P)

PARENT_EVENT_ID

string

Unique ID of the parent event.

INCIDENT_IMPACT

string

Possible values are: Minor
Moderate
Major
Severe



Real-Time Parking Lot Occupancy

Real-Time Parking Lot Occupancy data is accessed from http://4.31.137.82/DFW511/PublicWebServices/DFW511_WebServices.asmx and the web method to use is getParkingLotData(). Each parking lot contains information as described below. To assist with programming, an XSD document has been provided.

The data is returned in the following format. Parking stations can contain multiple parking lots.

<PARKING_STATIONS>
  <PARKING_STATION>
    <PARKING_STATION_ID>1</PARKING_STATION_ID>
    <PARKING_STATION_NAME>Parker Station</PARKING_STATION_NAME>
    <PARKING_STATION_ADDRESS>600 ARCHERWOOD ST. PLANO, Texas</PARKING_STATION_ADDRESS>
    <LATITUDE>33.03641</LATITUDE>
    <LONGITUDE>-96.70192</LATITUDE>
    <PARKING_LOTS>
      <PARKING_LOT>
        <PARKING_LOT_ID>1</PARKING_LOT_ID>
        <PARKING_LOT_NAME>Lot A</PARKING_LOT_NAME>
        <CAPACITY>828</CAPACITY>
        <UTILIZATION>78</UTILIZATION>
        <AVAILABILITY>750</AVAILABILITY>
        <LAST_UPDATED_REC>9/22/2014 7:09:55 PM</LAST_UPDATED_REC>
      </PARKING_LOT>
      <PARKING_LOT>
      ...
      </PARKING_LOT>
    <PARKING_LOTS>
  </PARKING_STATION>
  <PARKING_STATION>
    ...
  </PARKING_STATION>
</PARKING_STATIONS>

 

The following are details on the data elements:

Attribute

Type

Description

PARKING_STATION_ID

integer

Unique parking station ID.

PARKING_STATION_NAME

string

Name of parking station.

PARKING_STATION_ADDRESS

string

Address of parking station.

LATITUDE

float

Parking station latitude coordinate value.

LONGITUDE

float

Parking station longitude coordinate value.

PARKING_LOT_ID

integer

Unique parking lot ID.

PARKING_LOT_NAME

string

Name of parking lot.

CAPACITY

integer

Parking lot total capacity.

UTILIZATION

integer

Current number of parking lot spaces occupied.

AVAILABILITY

integer

Current number of parking lot spaces available.

LAST_UPDATED_REC

datetime

Date and time the parking lot information was last updated.



Real-Time Transit Vehicle Location and Occupancy Data

Real-Time Transit Vehicle Location and Occupancy data is accessed from http://4.31.137.82/DFW511/PublicWebServices/DFW511_WebServices.asmx and the web method to use is getTransitVehicleLocation(). Each transit vehicle 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

Numerical identifier of route type. Possible values are:
0: Tram, Streetcar, Light rail. Any light rail or street level system within a metropolitan area.
1: Subway, Metro. Any underground rail system within a metropolitan area.
2: Rail. Used for intercity or long-distance travel.
3: Bus. Used for short- and long-distance bus routes.
4: Ferry. Used for short- and long-distance boat service.
5: Cable car. Used for street-level cable cars where the cable runs beneath the car.
6: Gondola, Suspended cable car. Typically used for aerial cable cars where the car is suspended from the cable.
7: 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.

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

integer

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.