Proximity Reference

The Proximity Reference object is implemented as the ProximityReference class. The attributes of a ProximityReference are:

Attribute	Description
PlaceType	A string indicating the type of the place. Either a "TOWN" or a "CITY".
Distance	A floating point (double) number indicating the distance from the mobile (a tractor or a trailer) and this reference point.
PlaceName	A string containing the name of the proximity reference. This string is empty in the case of a city or a town.
City	A string containing the name of the city or town in which this place is located.
State	The two character abbreviation of the state or province in which this place is located.
Country	A string containing the country in which this place reference is located.
Zip	A string containing the postal code of this place reference.

Here is how a Proximity Reference is defined in the WSDL.

<complexType name="ProximityReference">

<sequence>

<element name="placeType" nillable="true" type="xsd:string"/>

<element name="distance" type="xsd:double"/>

<element name="direction" nillable="true" type="xsd:string"/>

<element name="placeName" nillable="true" type="xsd:string"/>

<element name="city" nillable="true" type="xsd:string"/>

<element name="state" nillable="true" type="xsd:string"/>

<element name="country" nillable="true" type="xsd:string"/>

<element name="zip" nillable="true" type="xsd:string"/>

</sequence>

</complexType>

Here is an example that shows what the Proximity Reference object will look like in XML.

<proximityTown>

<placeType>TOWN</placeType>

<distance>0.91</distance>

<direction>NW</direction>

<placeName xsi:nil="true" />

<city>Seminole</city>

<state>FL</state>

<country>US</country>

<zip>34642</zip>

</proximityTown>