Previous Topic: Updating OrganizationsNext Topic: Refreshing the Organization Cache

RiskMinder Web Services Developer's Guide › Managing Organizations › Updating Organization Status

Updating Organization Status

The updateOrgStatus operation is used to update the status of the organization in the RiskMinder database.

This section walks you through the following steps for updating the organization status:

Note: After you update the organization status, 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.

Preparing the Request Message

The updateOrgStatusRequest message is used to update the organization status. The following table lists the elements of this request message.

Element

Mandatory

Description

status

Yes

The status of the organization in the database:

  • INITIAL
    Indicates that the organization is not yet activated and cannot be used for any operations.
  • ACTIVE
    Indicates that the organization has been successfully created and activated. You can perform any operation on the organization.
  • INACTIVE
    Indicates that the organization has been deactivated. To perform any further operation, you must first activate the organization.
  • DELETED
    Indicates that the organization has been deleted and cannot be used anymore.

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 update the organization status:

  1. (Optional) Include the authentication and authorization details in the header of the updateOrgStatus operation. See "Managing Web Services Security" for more information on the header elements.
  2. Use the upateOrgStatusRequest elements to update the organization status, as listed in the table.
  3. Use the upateOrgStatusRequest message and construct the input message by using the details specified in the preceding step.
  4. Invoke the updateOrgStatus operation of the ArcorUserRegistryMgmtSvc service to update the organization status.

    This operation returns the updateOrgStatusResponse 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, updateOrgStatusResponse, 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.