Skip to main content
Omnitracs Knowledge Base

Delete Landmark

deleteLandmark

Deletes the specified landmark and all of its inventory history. If the specified landmark is the "primary" landmark of a landmark association, then any associated landmarks and their corresponding inventory history will also be deleted.        

void deleteLandmark(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 to be deleted. 
  • landmarkAlias: (optional) A string, maximum length 25, specifying the unique alias of the landmark to be deleted. This parameter is ignored if a landmarkName is specified.

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
- Can maintain landmarks

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>

   <deleteLandmark>

      <companyId>MYCOMPANY</companyId>

      <landmarkName>ABC Frozen Foods</landmarkName>

      <landmarkAlias></landmarkAlias>

   </deleteLandmark>

</soap:Body>

 

Sample XML Response

An empty response conveys success. If there was an error, an exception would have been thrown.

<soapenv:Body>

   <deleteLandmarkResponse/>

</soapenv:Body>

 

Exceptions

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

  • Was this article helpful?