Previous Topic: Fetching Email and Telephone TypesNext Topic: Fetching Telephone Types

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

Fetching Email Types

The listEmailTypes operation is used to fetch the email address types that are configured for an organization.

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

Preparing the Request Message

The listEmailTypeRequest message is used to fetch email address 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 email 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.

Invoking the Web Service

To fetch email address types:

  1. (Optional) Include the authentication and authorization details in the header of the listEmailTypes operation. See chapter, "Managing Web Services Security" for more information on the header elements.
  2. Use the listEmailTypeRequest elements to get the organization name.
  3. Use the listEmailTypeRequest message and construct the input message by using the details obtained in preceding step.
  4. Invoke the listEmailTypes operation of the ArcotConfigRegistrySvc service to fetch the email address types.

    This operation returns the listEmailTypeResponse message that includes the transaction identifier, authentication token, and email address types. See the following section for more information on the response message.

Interpreting the Response Message

The response message, listEmailTypeResponse, returns the transaction identifier and the authentication token in the SOAP envelope header. The SOAP body includes the email address 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 email type is configured at the global level. Possible values are:

  • True: Indicates that the email type is configured at the global level.
  • False: Indicates that the email type is configured at the organization level.

emailType/name

The name of the email address type.

emailType/displayName

The display name of the email address type.

emailType/priority

The priority of the email type if more than one email type has been configured.

emailType/isMandatory

Indicates whether the email type is mandatory.