Web Service Explanation

A third-party external distance engine can be defined using EDE with the connection type of “WebService (W)” and using a java class glog.business.rate.ratedistance.external.webservice.client.ExternalDistanceWebServiceClient. Transportation Management as web service client connects to the custom third-party distance engine web service that adheres to the WSDL interface.

validateAddress Operation

Inputs

validateAddress operation takes validateAddressRequest as input that contain below element as child elements

  • sourceAddress contains all the location information for the source address.
  • destinationAddress contains all the location information for the destination address.
  • extEngineAuxInputList contain SCAC and Route Codes off the locations, contains the equipment dimensions, weight and volume of the equipment being used for transportation and contains hazardous material information being shipped if hazardous routing is enabled. The SCAC and Route Codes are usually only necessary for rail lookups. This element is available as read-only. Mostly the information from this element is not used for address validation.
  • edeParams is a mapping to all the input parameters that were entered in Oracle Transportation and Global Trade Management Cloud for the specific EDE.

Outputs

locationAddressMatches is the result of the validateAddress operation. locationAddressMatches element contains two child elements.

  • validFlag: indicate where location is valid or not.
  • possibleMatches: for engines that support multiple suggested locations, this element contain possible location’s data for given input.

An unsuccessful call to locationAddressMatches will return fault to indicate exception scenario with reason being populated in ExtEngineException element.

Note: All the values for XML elements involved in web service should be valid as per the Distance Engine WSDL defined in WSDLs appendix section.