Skip to main content

SOAP API

Customers

In the SOAP API, you can use these customer-related methods:

  1. createCustomer()

    A customer can be created by specifying the XTMCustomerAPI object. The information is divided into the following groups:

    • customer name, external descriptor, and VAT number.

    • address details.

    • instant messaging identifiers.

    • additional settings.

    • custom fields.

    Most of the fields are optional. However, the following are mandatory and must be specified:

    • name.

    XTMExternalCustomerDescriptorAPI: externalId

    External customer descriptor needs to be specified to use customer external ID in other methods instead of the customer ID from XTM Cloud.

  2. updateCustomer()

    This method can be used to update the following customer data:

    • name.

    • address.

    • custom fields.

  3. updateCustomerActivity()

    This method can be used to delete the specified customers. It requires a list of customer descriptors and activity (XTM_CUSTOMER_ACTIVITY).

    XTM_CUSTOMER_ACTIVITY – a list of possible activities

    • DELETE

      Deletes customer.

  4. findCustomer()

    This method can be used to search for customers. It is necessary to specify search parameters in the XTMFindCustomerAPI object. This method returns all customers with details matching the specified criteria. Possible criteria are: a list of the XTMCustomerDescriptorAPI objects, XTMCustomerPMDescriptorAPI, and XTMCustomerActivityFilterEnum.

    XTMCustomerActivityFilterEnum – a list of customer activity statuses available during the search for customers:

    • ONLY_ACTIVE

      Search only for active customers.

    • ALL

      Search for active and deactivated customers.

  5. copyCustomer()

    This method can be used to copy any or all of the following data between customers:

    • Project Manager.

    • estimates factors.

    • language combinations.

    • domains.

    Each field to copy is specified by the XTMCustomerCopyFieldType object.

    XTMCustomerCopyFieldType – a list of possible copy types:

    Table 4. : XTMUserProjectsVisibilityEnum – possible options for project visibility for a Project Manager

    Option

    Description

    NONE

    The field will not be copied (default value if not set).

    FULL

    The field will be copied.