Creating Account Types

RiskMinder Web Services Developer's Guide › Managing Additional User Configurations › Managing Account Types › Creating Account Types

Creating Account Types

This section walks you through the steps for creating account types:

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

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

Preparing the Request Message

The createAccountTypeRequest message is used to create account types in the RiskMinder database. The following table lists the elements of this request message.

Element	Mandatory	Description
accountType/name	Yes	The name of the account type that you want to create.
accountType/displayName	Yes	A descriptive name for the account type.
accountType/customAttribute	No	Name-value pairs that you can use to specify additional information related to account types.
targetAllOrgs	No	Indicates whether the account type should be assigned to all organizations: true: Account type is assigned to all organizations. false: Account type is assigned only to the organizations that are listed in the ListOfOrganizations element. Note: By default, the value of this element is set to false.
ListofOrganizations/Organization/ orgName	No	The name of the organization to which the account type must be assigned.
ListofOrganizations/Organization/ customAttribute	No	The custom attribute that you have set for the organization to which you want to assign the account type.
clientTxId	No	Unique transaction identifier that your calling application can include. This identifier helps in tracking the related transactions.

Invoking the Web Service

To create account types:

(Optional) Include the authentication and authorization details in the header of the createAccountType operation. See "Managing Web Services Security" for more information on the header elements.
Use the createAccountTypeRequest elements to set the account information, as listed in the table.
Use the createAccountTypeRequest message and construct the input message by using the details specified in the preceding step.
Invoke the createAccountType operation of the ArcotConfigRegistrySvc service to create the account type.
This operation returns the createAccountTypeResponse 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, createAccountTypeResponse, 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.