Get Landmark Names List

Last updated
Save as PDF

getLandmarkNamesList

Given a CompanyID (optional), Landmark name (optional), and number of landmarks to return, this web service returns a list of LandmarkNames objects starting after the landmark name that was specified. Only the most basic attributes (Name, Aliases) are returned for each landmark.

LandmarkNames[] getLandmarkNamesList(string companyId, string landmarkName, int numOfLandmarks) 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. The returned list will begin after (alphabetically) the landmark that is specified on the call. When the landmarkName is blank, the list will begin with the first landmark in alphabetical order by landmark name.
numberOfLandmarks: The number of landmarks to return in the list. The value must be between 1 and 32,766.

Returns a null string on exceptions; otherwise returns an array of LandmarkNames objects (containing only a Landmark's Name and Aliases elements).

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>

<getLandmarkNamesList>

<companyId>testCompany</companyId>

<landmarkName>TestLandmark</landmarkName>

<numberOfLandmarks>2</numberOfLandmarks>

</getLandmarkNamesList>

</soap:Body>

Sample XML Response

<soapenv:Body>

<getLandmarkNamesListResponse>

<getLandmarkNamesListReturn>

<LandmarkNames>

<aliases>

<string>PLACE2ALIAS1</string>

<string>PLACE2ALIAS2</string>

<string>PLACE2ALIAS3</string>

</aliases>

<name>CREATEDBYSOAPUITESTSUITE2</name>

</LandmarkNames>

<LandmarkNames>

<aliases>

<string>PLACE3ALIAS1</string>

<string>PLACE3ALIAS2</string>

<string>PLACE3ALIAS3</string>

</aliases>

<name>CREATEDBYSOAPUITESTSUITE3</name>

</LandmarkNames>

</getLandmarkNamesListReturn>

</getLandmarkNamesListResponse>

</soapenv:Body>

Exceptions

001 Unknown Error.
002 Required field not specified.
003 Company not authorized for integration.
004 User not authorized.
005 Landmarks cannot be found with specified information.
006 Invalid companyId specified.
007 Invalid number of records specified.
008 User cannot retrieve details for specified company.