Get Landmark Details

Last updated
Save as PDF

getLandmarkDetails

This web service returns a Landmark object containing information pertaining to a specified landmark. Identification of the desired landmark may be accomplished in one of two ways: specifying the landmark's name or alias.

Landmark getLandmarkDetails(string companyId, string landmarkName, string landmarkAlias) throws WSException

companyId: (optional) A string, maximum length 10, specifying the unique company identifier.
NOTE: If no companyId is specified, the company of the authorized user making the call will be used.
landmarkName: (optional) A string, maximum length 25, specifying the unique name of the landmark whose details are to be retrieved.
landmarkAlias: (optional) A string, maximum length 25, specifying the unique alias of the landmark whose details are to be retrieved. This parameter is ignored if a landmarkName is specified.

Returns a null string on exceptions; otherwise returns a Landmark object.

Authorization Requirements

The credentials supplied with this method call (as specified in the accompanying WS-Security header) must be authorized to the following application(s) and their associated role-based permissions.

Required Application Licenses
- Remote Integration

Required User Permissions
- Can use GeoServices

Customer integrators are authorized to their own company's data only.

Sample XML Request

Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.

<soap:Body>

<getLandmarkDetails>

<companyId>MYCOMPANY</companyId>

<landmarkName>Superior Distribution Inc</landmarkName>

<landmarkAlias></landmarkAlias>

</getLandmarkDetails>

</soap:Body>

Sample XML Response

<soapenv:Body>

<p503:getLandmarkDetailsResponse xmlns:p503="http://websvcs.oloxwebws">

<getLandmarkDetailsReturn>

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

</getLandmarkDetailsReturn>

</getLandmarkDetailsResponse>

</soapenv:Body>

Exceptions

001 Unknown Error.
003 Company not authorized for integration.
004 User not authorized.
005 User cannot retrieve details for specified company.
006 Landmark name or alias must be specified.
007 Landmark cannot be found with specified information.