Web services provided by ContactManager

ContactManager provides the following web services. The first one, ABContactAPI, is the primary web service used by Guidewire core applications to communicate with ContactManager. The second one, ABVendorEvaluationAPI, supports vendor evaluations. The remaining web services are standard services available in all Guidewire applications.

For a complete list of base configuration web services, see Reference of all web services in the base configuration

Web Service

Description

More information

ABContactAPI

The primary web service used by Guidewire core applications to search for, create, update, and delete contacts. This web service’s WSDL is retrieved by every Guidewire core application to make it available to the application plugin that communicates with ContactManager. The class package is gw.webservice.ab.ab1000.abcontactapi.

ABContactAPI web service

ABVendorEvaluationAPI

A web service that enables ClaimCenter to send and receive review summary information. The class package is gw.webservice.ab.ab1000.abvendorevaluationapi.

ImportToolsAPI

Imports administrative data from an XML file. Use this web service only with administrative database tables, such as entities of type User. The system does not perform complete data validation tests on any other type of imported data.

Importing administrative data

LoginAPI

WS-I authentication happens with each API call. However, if you want to explicitly test specific authentication credentials in your web service client code, ContactManager publishes the built-in LoginAPI web service. Call this web service’s login method, which takes a user name as a String and a password as a String. If authentication fails, the API throws an exception. You can also use LoginAPI to purposely leave a user session open for logging purposes.

Login authentication confirmation

MaintenanceToolsAPI

Provides a set of tools that start and manage various background processes. The methods of this web service are available only when the server run level is maintenance or higher.

Maintenance tools web service

MessagingToolsAPI

Provides messaging methods for managing the messaging system remotely for recovery from message acknowledgment errors. The methods of this web service are available only when the server run level is multiuser.

Messaging tools web service

PersonalDataDestructionAPI

Enables an external application to request:

  • Destruction of a contact’s data by AddressBookUID or by PublicID.
  • Destruction of a user by user name.

Data destruction web service

ProfilerAPI

Sends information to the built-in system profiler.

The Profiler API web service

SystemToolsAPI

Provides a set of tools that are always available, even if the server is set to DBMaintenance run level. For servers in clusters, system tools API methods execute only on the server that receives the request. Some uses of this web service include:

  • Getting the version of the server, including application version and schema version
  • Checking the consistency of the underlying physical database
  • Getting and setting the run level

System tools web service

TableImportAPI

Provides a table-based import interface for high volume data import. This web service is typically used for large-scale data conversions, particularly for migrating records from a legacy system into ContactManager prior to bringing ContactManager into production.

Table import web service

TypelistToolsAPI

Provides tools for getting the list of valid typecodes for a typelist and for mapping between ContactManager internal codes and codes in external systems.

Mapping typecodes and external system codes

WorkflowAPI

Performs various actions on a workflow, such as suspending and resuming workflows and invoking workflow triggers.

Workflow web service

ZoneImportAPI

Imports geographic zone data from a comma separated value (CSV) file into a staging table, in preparation for loading zone data into the operational table.

Zone data import web service