Get Suspended Landmark Notifications

Last updated
Save as PDF

getSuspendedLandmarkNotifications

This webservice retrieves a list of suspended landmark/asset pairs for a company or a list of suspended landmark/asset pairs for an asset.

SuspendedLandmark[] getSuspendedLandmarkNotifications (String companyId, String LandmarkId, AssetIdentifier asset, String assetType, int numberOfRecords) throws WSException

companyId: (optional) A string of maximum length 10 that specifies the unique company identifier. If no company is specified, the company of the authorized user will be used.
landmarkId: (optional) A string, maximum length 25, specifying the unique name of the landmark whose notification suspensions will be returned. If not specified, all landmarks for the company or asset are returned.
asset: (optional) An OLOXWebSvcs AssetIdentifier object containing the SCAC and ID of the asset whose notification suspensions will be returned. If not specified, all assets for the company or landmark are returned.
assetType: (optional - Required if asset is specified, otherwise it is ignored). A string of length 1 that is used to indicate the type of the asset. Possible values are:
- 0 = vehicle
- 1 = trailer
numberOfRecords: The number of suspended landmark objects 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 SuspendedLandmark objects.

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>

<getSuspendedLandmarkNotifications>

<companyId>MYCOMPANY</companyId>

<landmarkId>CUSTOMERA</landmarkId>

<asset>

<id>TRAILER123</id>

<scac>SCAC</scac>

</asset>

<assetType>1</assetType>

<numberOfRecords>1</numberOfRecords>

</getSuspendedLandmarkNotifications>

</soap:Body>

Sample XML Response

<soap:Body>

<getSuspendedLandmarkNotificationsResponse>

<getSuspendedLandmarkNotificationsReturn>

<SuspendedLandmark>

<asset>

<id>TRAILER123</id>

<scac>SCAC</scac>

</asset>

<assetType>1</assetType>

<landmarkNames>

<aliases>

<string>CUSTAALIAS1</string>

<string>CUSTAALIAS2</string>

</aliases>

<name>CUSTOMERA</name>

</landmarkNames>

</SuspendedLandmark>

</getSuspendedLandmarkNotificationsReturn>

</getSuspendedLandmarkNotificationsResponse>

</soap:Body>

Exceptions

001 Unknown Error.
003 Company not authorized for integration.
004 User not authorized.
005 Invalid company id.
006 Landmark not found.
007 Asset not found.
008 Asset type is required.
009 Invalid number of records specified.