Refreshing the Organization Cache

RiskMinder Web Services Developer's Guide › Managing Organizations › Refreshing the Organization Cache

Refreshing the Organization Cache

The refreshCache operation is used to refresh the organization configurations that are stored in the cache. This section walks you through the following steps for refreshing the organization cache:

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

Preparing the Request Message

The refreshCacheRequest message is used to refresh the organization cache. The following table lists the elements of this request message.

Element	Mandatory	Description

systemCache	No	Specifies whether you want to refresh the system cache: True: Indicates that the system cache will be refreshed. False: Indicates that the system cache will not be refreshed.
Note: You can set any one of the following elements.
allOrganizations	No	Specifies whether the cache of all organizations has to be refreshed. Set the value of this element to TRUE to refresh the cache of all organizations.
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.

Invoking the Web Service

To refresh the organization cache:

(Optional) Include the authentication and authorization details in the header of the refreshCache operation. See "Managing Web Services Security" for more information on the header elements.
Use the refreshCacheRequest elements for updating the organization configurations, as listed in the table.
Use the refreshCacheRequest message and construct the input message by using the details specified in the preceding step.
Invoke the refreshCache operation of the ArcorUserRegistryMgmtSvc service to refresh the organization cache.
This operation returns the refreshCacheResponse 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, refreshCacheResponse, 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.

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.