Create/Update Organization

The CreateOrganization outbound service interface is used to notify an external system of the creation or registration of an organization, whereas the UpdateOrganization outbound service interface is used to notify an external system of the update of an organization.

This service is configured with the wc-invocation-client.xml file. For more information and a sample file, see Customizing the Web service client invocation XML file.

Deprecated: The integration service interfaces documented in this topic are deprecated. Use the Order management system integration service interfaces.

Request

Request to the CreateOrganization outbound service interface is in the form of a SyncOrganization business object document (BOD) with action code Create. Request to the UpdateOrganization outbound service interface is in the form of a SyncOrganization BOD with action code Update. The definition of the SyncOrganization BOD can be found in the XML schema file workspace_dir/WebServicesRouter/xsd/OAGIS/9.0/Overlays/IBM/Commerce/BODs/SyncOrganization.xsd. The service data object (SDO) interface of the SyncOrganization BOD is com.ibm.commerce.member.datatypes.SyncOrganizationType.

Response

Response to a successful request is in the form of a ConfirmBOD BOD. The XML schema of the ConfirmBOD BOD can be found in the XML schema file workspace_dir/WebServicesRouter/xsd/OAGIS/9.0/BODs/Developer/ConfirmBOD.xsd. The service data object (SDO) interface of the ConfirmBOD BOD is com.ibm.commerce.oagis9.datatypes.ConfirmBODType.

Message type

The CreateOrganization outbound service interface is mapped to the message type com.ibm.commerce.member.CreateOrganization, or com.ibm.commerce.member if the former is not defined. The UpdateOrganization outbound service interface is mapped to the message type com.ibm.commerce.member.UpdateOrganization, or com.ibm.commerce.member if the former is not defined.

Client task command

These outbound service interfaces can be invoked by calling the order client task command com.ibm.commerce.member.client.commands.SyncOrganizationCmd with action CreateOrganization or UpdateOrganization. Its default implementation, com.ibm.commerce.member.client.commands.SyncOrganizationCmdImpl , behaves as follows:

  • It first calls the protected method composeSyncOrganization() to compose a SyncOrganization SDO from the organization ID or organization access bean specified.
  • It then passes the action and the SyncOrganization SDO to the member client facade implementation to make the outbound service request.

Usage scenarios

Register organization

  1. When an organization registration is approved, the command com.ibm.commerce.usermanagement.commands.OrgEntityRegistrationAddPostApprovalCmd is called.
  2. The service-oriented integration (SOI)-specific implementation of this command, com.ibm.commerce.soi.commands.SOIOrgEntityRegistrationAddPostApprovalCmdImpl , calls the member client task command com.ibm.commerce.member.client.commands.SyncOrganizationCmd with action CreateOrganization to notify the external system of the organization registration.

Create organization

  1. When an organization is created by either a shopper or customer service representative (CSR), the command com.ibm.commerce.usermanagement.commands.OrgEntityAddCmd is called.
  2. At the end of its execution, this command calls the command com.ibm.commerce.usermanagement.commands.PostOrgEntityAddCmd to perform more actions.
  3. The SOI-specific implementation of this command, com.ibm.commerce.soi.commands.SOIPostOrgEntityAddCmdImpl , calls the member client task command com.ibm.commerce.member.client.commands.SyncOrganizationCmd with action CreateOrganization to notify the external system of the organization creation.

Update organization

  1. When an organization is updated by a user, the command com.ibm.commerce.usermanagement.commands.OrgEntityUpdateCmd is called.
  2. At the end of its execution, this command calls the command com.ibm.commerce.usermanagement.commands.PostOrgEntityUpdateCmd to perform more actions.
  3. The SOI-specific implementation of this command, com.ibm.commerce.soi.commands.SOIPostOrgEntityAddCmdImpl , calls the member client task command com.ibm.commerce.member.client.commands.SyncOrganizationCmd with action UpdateOrganization to notify the external system of the organization update.