Previous Topic: getContactNext Topic: Group Management Methods

Web Services Methods › Contact Management Methods › findContacts

findContacts

The following parameters apply to the findContacts method:

Parameter

Type

Description

SID

Integer

Identifies the session retrieved from logging in.

userName

String

Returns only the contacts with this user name. You can do wildcard searches by using the percent (%) sign.

For example, to search for all contacts where the User Name begins with Smi, specify Smi%.

lastName

String

Returns only the contacts with this last name. You can do wildcard searches by using the percent (%) sign.

firstName

String

Returns only the contacts with this first name. You can do wildcard searches by using the percent (%) sign.

email

String

Returns only the contacts with this email address. You can do wildcard searches by using the percent (%) sign.

accessType

String

Returns only the contacts with this access type. You can specify multiple roles by separating them with commas. Specify the following:

  • 10002 - Administration
  • 10004 - Customer
  • 10005 - Employee
  • 10009 - IT Staff
  • 10013 - Knowledge Management
  • 10014 - Process Management
  • 10010 - Service Desk Management
  • 10008 - Service Desk Staff
  • 10020 - Vendor Staff

inactiveFlag

Integer

Returns only the contacts that are inactive or active. Specify the following:

  • 0 for active
  • –999 for all
  • other for inactive

Description

Retrieves the list of contacts.

Returns

A <UDSObjectList> node with zero or more <UDSObject> nodes describing contacts with the following <Attributes> child nodes:

XML Element Value

Type

Description

id

UUID

Specifies the unique ID of the contact.

userid

String

Specifies the user name of the contact.

last_name

String

Identifies the last name of the contact.

first_name

String

Identifies the first name of the contact.

access_type

Integer

Specifies the Role ID of the contact.

delete_flag

Integer

Indicates whether the contact is active or inactive:

  • 0 - Active
  • 1 - Inactive

loginWithArtifact

The following parameters apply to the loginWithArtifact method:

Parameter

Type

Description

userid

String

Identifies the user ID.

artifact

String

Identifies the Artifact obtained from CA EEM.

Description

Performs the user authentication by the provided CA EEM Artifact and opens a session with the back-end server. The Artifact can be used only once for authentication. The returned session ID (SID) can be used for subsequent web services method invocations. The Artifact can be acquired directly from CA EEM or can be obtained by the getArtifact method.

Note: Service Desk needs to be integrated with CA EEM to perform this operation.

The SID should be freed with logout(). A SID may expire if it is not used before a timeout elapses.

Returns

The following is returned:

Parameter

Type

Description

SID

String

Identifies the unique session ID (SID) to use for all other Web Services calls. It is in plain text format.