Skip to main content
Omnitracs Knowledge Base

Edit Landmark Attributes

editLandmarkAttributes

This web service edits a landmark's type specific attributes with the supplied values.

void editLandmarkAttributes(string companyId, string landmarkName, string landmarkAlias, LandmarkAttribute[] attributes) 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 retreived. 
  • landmarkAlias: (optional) A string, maximum length 25, specifying the unique alias of the landmark whose details are to be retreived. This parameter is ignored if a landmarkName is specified.
  • attributes: An array of LandmarkAttribute objects with the values for the landmark attributes.

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>

   <editLandmarkAttributes>

      <companyId>MYCOMPANY</companyId>

      <landmarkName></landmarkName>

      <landmarkAlias>JTS Disposal West</landmarkAlias>

      <attributes>

         <LandmarkAttribute>

            <attributeID>contactAName</attributeID>

            <value>John F. Smith</value>

         </LandmarkAttribute>

         <LandmarkAttribute>

            <attributeID>contactANumber</attributeID>

            <value>570-123-4567~</value>

         </LandmarkAttribute>

      </attributes>

   </editLandmarkAttributes>

</soap:Body>

Sample XML Response

<soapenv:Body>

   <editLandmarkAttributesResponse/>

</soapenv:Body>

Exceptions

001 Unknown Error.
003 Company not authorized for integration.
004 User not authorized.
005 User cannot edit landmark attributes for specified company.
006 Landmark name or alias must be specified.
007 Landmark cannot be found with specified information.
008 Must specify at least one attribute and value.
009 Attribute errors - dynamically filled with attribute failure code:attribute ID in a semi-colon delimited string
      -- an example: 009 Attribute errors - 0007:contactAName;0007:contactBName
      -- see the table below for all valid attribute failure codes and their meanings

 

Attribute Error Code

 

 

Error Description

 

0001

attributeID contains an illegal character

0002

attributeID is not associated with the specified Landmark

0003

attributeID is invalid

0004

value is not a boolean value as required

0005

value contains an illegal character

0006

value is not in numeric format as required

0007

value exceeds the allowed maximum length

0008

value not within the allowed number range

0009

value is not one of the qualified numeric values

0010

value is not one of the qualified character values

  • Was this article helpful?