Customers
In the SOAP API, you can use these customer-related methods:
createCustomer()
A customer can be created by specifying the
XTMCustomerAPIobject. 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:externalIdExternal customer descriptor needs to be specified to use customer external
IDin other methods instead of the customerIDfrom XTM Cloud.updateCustomer()
This method can be used to update the following customer data:
name.
address.
custom fields.
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 activitiesDELETEDeletes customer.
findCustomer()
This method can be used to search for customers. It is necessary to specify search parameters in the
XTMFindCustomerAPIobject. This method returns all customers with details matching the specified criteria. Possible criteria are: a list of theXTMCustomerDescriptorAPIobjects,XTMCustomerPMDescriptorAPI, andXTMCustomerActivityFilterEnum.XTMCustomerActivityFilterEnum– a list of customer activity statuses available during the search for customers:ONLY_ACTIVESearch only for active customers.
ALLSearch for active and deactivated customers.
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
XTMCustomerCopyFieldTypeobject.XTMCustomerCopyFieldType– a list of possible copy types:Table 4. : XTMUserProjectsVisibilityEnum – possible options for project visibility for a Project ManagerOption
Description
NONEThe field will not be copied (default value if not set).
FULLThe field will be copied.