The deleteOrg operation is used to delete organizations. After you delete an organization, the information related to that organization is still maintained in the system. Therefore, you cannot create an organization with the same name as that of the deleted organization.
This section walks you through the following steps for deleting organizations:
Note: After you delete an organization, you must refresh the system cache for the changes to take effect. See "Refreshing the Organization Cache" for more information on how to refresh the system cache.
The deleteOrgRequest message is used to delete organizations. The following table lists the elements of this request message.
|
Element |
Mandatory |
Description |
|---|---|---|
|
orgName |
Yes |
The unique name with which the organization is identified. |
|
clientTxId |
No |
Unique transaction identifier that your calling application can include. This identifier helps in tracking the related transactions. |
To delete organizations:
This operation returns the deleteOrgResponse message that includes the transaction identifier, authentication token, and organization details. See the following section for more information on the response message.
The response message, deleteOrgResponse, returns the transaction identifier and the 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, "Exceptions and Error Codes" for more information on the SOAP error messages.
|
Element |
Description |
|---|---|
|
udsTransactionID |
The unique identifier of the transaction performed by using UDS. |
|
authToken |
The authentication token that is returned if the credential verification to access the Web service was successful. This token eliminates the need for you to present the authentication credential for successive access to the Web service. By default, the authentication token is valid for one day, after which you need to authenticate again. |
|
Copyright © 2013 CA.
All rights reserved.
|
|