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


Deleting Account Types

The deleteAccountType operation is used to delete the account types that are associated with an organization.

This section walks you through the following topics for deleting account types:

Note: After you delete an account type, you must refresh the system cache for the deleted account type to take effect. See "Refreshing the Organization Cache" for more information on how to refresh the cache.

Preparing the Request Message

The deleteAccountTypeRequest message is used to delete account types in the AuthMinder database. The following table lists the elements of this request message:

Element

Mandatory

Description

accountType

Yes

The name of the account type that you want to delete.

clientTxId

No

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

Invoking the Web Service

To delete account types:

  1. (Optional) Include the authentication and authorization details in the header of the deleteAccountType operation. See chapter, "Managing Web Services Security" for more information on the header elements.
  2. Use the deleteAccountTypeRequest elements to get the account type that has to be deleted.
  3. Use the deleteAccountTypeRequest message and construct the input message by using the details obtained in preceding step.
  4. Invoke the deleteAccountType operation of the ArcotConfigRegistrySvc service to delete the account type.

    This operation returns the deleteAccountTypeResponse message that includes the transaction identifier and the authentication token. See the following section for more information on the response message.

Interpreting the Response Message

The response message, deleteAccountTypeResponse, returns the transaction identifier and authentication token in the SOAP envelope header. These elements are explained in the following table. The SOAP body returns a success message if the operation was performed successfully. If there are any errors, then the Fault response is returned. See appendix, "Error Codes" for more information on the SOAP error messages.

Element

Description

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.