Skip to main content
Omnitracs Knowledge Base

Landmark

Information about a landmark's definition is implemented in the Landmark object.  The attributes of the Landmark object are:

 

Attribute

 

 

Description

 

name

A string of maximum length 25 containing the name of the landmark.

address

An Address object containing the street address of the landmark.

aliases[]

An array of strings, maximum length 25 characters each, containing additional aliases used to uniquely identify the landmark. 
(presently, a landmark can have a maximum of 5 aliases) 

useInProxRef

A single character value indicating if the landmark should be referenced in asset (vehicle/trailer) position proximity references. Valid values are:
"0" - Do not use in position proximity references
"1" - Use in position proximity references

typeID

A string of maximum length 20 containing the landmark type ID of the landmark.
A list of valid landmark types can be found on the Landmark Types & Attributes page.

divisionID

A string of maximum length 10 containing the applicable division ID for the landmark.
Blank value indicates the landmark pertains to any/all company divisions.

createTime

A string containing a timestamp in the form YYYY-MM-DDTHH:MM:SSZ indicating the time (GMT) the landmark was created.

createUser

A string of maximum length 50 containing the user who created this landmark.

lastModTime

A string containing a timestamp in the form YYYY-MM-DDTHH:MM:SSZ indicating the time (GMT) the landmark was last modified.

lastModUser

A string of maximum length 50 containing the user who last modified this landmark.

polygon

An Polygon object containing details of the landmark's polygonal boundary.

circCentroidLat

A floating point (double) value containing the landmark's circular centroid latitude, expressed in signed decimal degrees.
The circular centroid of the landmark is the calculated center point coordinate of the smallest circular boundary which encompasses the landmark's entire polygonal boundary.  
A positive value (rounded to 6 decimal places) indicates the northern hemisphere. A negative value indicates the southern hemisphere.

circCentroidLong

A floating point (double) value containing the circular centroid longitude of the landmark, expressed in signed decimal degrees.
The circular centroid of the landmark is the calculated center point coordinate of the smallest circular boundary which encompasses the landmark's entire polygonal boundary.
A positive value (rounded to 6 decimal places) indicates the eastern hemisphere. A negative value indicates the western hemisphere.

circRadius

A floating point (double) number indicating the radius, from the circular centroid latitude/longitude coordinate, of the smallest circular boundary which encompasses the landmark's entire polygonal boundary. The smallest acceptable value is .01 (the distance is expressed in miles or kilometers, depending on your company's unit of measure preference) .

preArrRadius

A floating point (double) number indicating the radius, from the circular centroid latitude/longitude coordinate, to a circular pre-arrival boundary around the landmark.
NOTE: This value is now required to be a whole number, any decimal value passed in will be truncated to an integer.
(The distance is expressed in miles or kilometers, depending on your company's unit of measure preference) 

attributes[]

An array of LandmarkAttribute objects containing an attribute of the landmark and its value.

assocLandmarkNames[]

An array of strings, maximum length 25 characters each, containing the names of landmarks which are associated with the returned landmark.  

assocPrimaryLandmarkName

A string of maximum length 25 containing the name of the "primary" landmark within the landmark association.

WSDL Definition

Here is how the Landmark object is defined within the WSDL

<complexType name="Landmark">

   <sequence>

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

      <element name="address" nillable="true" type="tns2:Address"/>

      <element name="aliases" nillable="true" type="tns2:ArrayOf_xsd_nillable_string"/>

      <element name="useInProxRef" type="xsd:boolean"/>

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

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

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

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

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

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

      <element name="polygon" nillable="true" type="tns2:Polygon"/>

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

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

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

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

      <element name="attributes" nillable="true" type="impl:ArrayOf_tns2_nillable_LandmarkAttribute"/>

      <element name="assocLandmarkNames" nillable="true" type="tns2:ArrayOf_xsd_nillable_string"/>

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

   </sequence>

</complexType>







 

Sample XML

Here is a sample showing what the Landmark object would look like in XML

<Landmark>

   <name>Superior Distribution Inc</name>

   <address>

      <street>123 Main Street</street>

      <city>Morgantown</city>

      <state>PA</state>

      <country>US</country>

      <postalCode>19543</postalCode>

   </address>

   <aliases>

      <string>SDI</string>

      <string>SuperDist</string>

   </aliases>

   <useInProxRef>1</useInProxRef>

   <typeID>customer</typeID>

   <divisionID>RFR</divisionID>

   <createTime>2006-04-12T18:54:09Z</createTime>

   <createUser>DEMOUSER</createUser>

   <lastModTime>2009-07-02T13:21:47Z</lastModTime>

   <lastModUser>DEMOUSER</lastModUser>

   <polygon>

      <vertices>40.154556,-75.861175,40.15454,-75.86375,40.152535,-75.863514,40.152637,-75.86113</vertices>

      <centroidLat>40.153579</centroidLat>

      <centroidLong>-75.862403</centroidLong>

   </polygon>

   <circCentroidLat>40.153545</circCentroidLat>

   <circCentroidLong>-75.862441</circCentroidLong>

   <circRadius>0.09</circRadius>

   <preArrRadius>25.00</preArrRadius>

   <attributes>

      <LandmarkAttribute>

         <attributeID>contactAName</attributeID>

         <value>John E. Smith</value>

      </LandmarkAttribute>

      <LandmarkAttribute>

         <attributeID>contactANumber</attributeID>

         <value>610-123-4567</value>

      </LandmarkAttribute>

   </attributes>

   <assocLandmarkNames>

      <string>Superior Dist(Inbound)</string>

      <string>Superior Dist(Outbound)</string>

   </assocLandmarkNames>

   <assocPrimaryLandmarkName>Superior Distribution Inc</assocPrimaryLandmarkName>

</Landmark>

  • Was this article helpful?