PositionReference

Last updated
Save as PDF

The Position Reference object is identical to the ESS proximity element and is implemented as the Position Reference class. The attributes of a PositionReference are:

Attribute	Description
distance	A floating point (double) number indicating the distance to the location in kilometers or miles based on the target company's preference (if specified).
direction	A string containing the direction to the place using a compass notation with a maximum of 3 characters.
placeName	A string containing the unique name of the location if it is not a town or city. This string is empty in the case of a CITY or TOWN.
placeAlias	A String containing the first unique customer-defined alias of the place if not a CITY or TOWN. This string is empty in the case of a CITY or TOWN.
placeAlias2	A String containing the second unique customer-defined alias of the place if not a CITY or TOWN. This string is empty in the case of a CITY or TOWN.
placeAlias3	A String containing the third unique customer-defined alias of the place if not a CITY or TOWN. This string is empty in the case of a CITY or TOWN.
placeAlias4	A String containing the fourth unique customer-defined alias of the place if not a CITY or TOWN. This string is empty in the case of a CITY or TOWN.
placeAlias5	The fifth unique customer-defined alias of the place if not a CITY or TOWN. This string is empty in the case of a CITY or TOWN.
placeType	A String containing the type of the location. CITY, TOWN, or LANDMARK type.
city	A string containing the name of the CITY or TOWN in which this place is located.
stateProv	The two character abbreviation of the state or province in which this place is located.
postal	A string containing the postal code of this place reference. 12 character maximum.
country	A string containing the country in which this place reference is located.

WSDL Definition

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

<complexType name="PositionReference">

<sequence>

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

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

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

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

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

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

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

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

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

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

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

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

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

</sequence>

</complexType>

XML Example

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

<positionReference>

<distance>2.54<distance/>

<direction>NNE<direction/>

<placeName>CSDI<placeName/>

<placeAlias>Cornerstone Software<placeAlias/>

<placeType>Company Location<placeType/>

<city>Morgantown<city/>

<stateProv>PA<stateProv/>

<postal>19543<postal/>

<country>US<country/>

</positionReference>