Fetching Telephone Types

CA AuthMinder Web Services Guide › Configuration Management Web Service › Fetching Email and Telephone Types › Fetching Telephone Types

Fetching Telephone Types

The listTelephoneTypes operation is used to fetch the telephone types that are configured for an organization.

This section walks you through the following topics for fetching the telephone types configured for an organization:

Preparing the Request Message
Invoking the Web Service
Interpreting the Response Message

Preparing the Request Message

The listTelephoneTypeRequest message is used to fetch the telephone types that are configured for the organization. The following table lists the elements of this request message:

Element	Mandatory	Description
orgName	No	The name of the organization for which the telephone address types have to be fetched.
clientTxId	No	Unique transaction identifier that the calling application can include. This identifier helps in tracking the related transactions.

Element

Mandatory

Description

orgName

The name of the organization for which the telephone address types have to be fetched.

clientTxId

Unique transaction identifier that the calling application can include. This identifier helps in tracking the related transactions.

Invoking the Web Service

To fetch telephone types:

(Optional) Include the authentication and authorization details in the header of the listTelephoneTypes operation. See chapter, "Managing Web Services Security" for more information on the header elements.
Use the listTelephoneTypeRequest elements to get the organization name.
Use the listTelephoneTypeRequest message and construct the input message by using the details obtained in preceding step.
Invoke the listTelephoneTypes operation of the ArcotConfigRegistrySvc service to fetch the telephone types.
This operation returns the listTelephoneTypeResponse message that includes the transaction identifier, authentication token, and telephone types. See the following section for more information on the response message.

Interpreting the Response Message

The response message, listTelephoneTypeResponse, returns the transaction identifier and the authentication token in the SOAP envelope header. The SOAP body includes the telephone types for a successful transaction and the fault response for an error condition.

The following table provides more information about the elements returned for a successful transaction. See appendix, "Error Codes" if there are any errors.

Element	Description

Header Elements
udsTransactionID	The unique identifier of the transaction that is performed using UDS.
authToken	The authentication token that is returned if the credential verification to access Web services was successful. This token eliminates the need for you to present the authentication credential for successive access to the Web services. By default, the authentication token is valid for one day, after which you need to authenticate again.
Body Elements
isGlobal	Specifies whether the telephone type is configured at the global level. Possible values are: True: Indicates that the telephone type is configured at the global level. False: Indicates that the telephone type is configured at the organization level.
TelephoneType/name	The name of the telephone type.
TelephoneType/displayName	The display name of the telephone type.
TelephoneType/priority	The priority of the telephone type if more than one telephone type has been configured.
TelephoneType/isMandatory	Indicates whether the telephone type is mandatory.