OrgEntityAdd command

This command registers a new organization or organizational unit. Information for new organizations or organizational units are stored in the MEMBER, ORGENTITY, MBRREL, and ADDRESS database tables.

Use this command with SSL (Secure Sockets Layer) to ensure that the information are encrypted. To do so type the command with the HTTPS secure protocol.

Command structure

http://host_name/path/
The fully qualified name of your WebSphere Commerce Server and the configuration path.

Parameter values

URL (Required)
The URL to be called when the command completes successfully.
orgEntityName (Required)
The name of the organization or organizational unit.
orgEntityType (Required)
The type of the organizational entity being added.
parentMemberId
(Required if orgEntityType equals 'O' and parentMemberId is not specified) The member ID of the parent organization or organizational unit being added; it is a foreign key reference to the MEMBER table. For an organization (orgEntityType=O), this parameter is not mandatory. For an organizational unit (orgEntityType=OU), this parameter is mandatory and should contain the parent member ID of the organization or organizational unit.
distinguishedName
Distinguished name of the organization or organizational unit, for LDAP use.
administratorFirstName
The first name of the administrator.
administratorLastName
The last name of the administrator.
administratorMiddleName
The middle name of the administrator.
businessCategory
Describes the kind of business performed by an organization or organizational unit.
description
A description of the registrant.
legalId
Registered organization identifier; may be null for an organizational unit.
orgEntityField1 through orgEntityField3
Customizable fields.
taxPayerId
The ID for the tax payer as specified in the ORGENTITY table.
address1 through address3
The registrant's street address, to a maximum of three lines of information.
addressField1 through addressField3
Customizable fields.
addressType
Type of address, valid values are configurable by using a properties file: S (shipto), B (billto), and SB (both shipto and billto). A single address may be of different types. If a properties file cannot be found, a default of SB will be used.
bestCallingTime
billingCode
The registrant's organization's code to identify the shipping or billing addresses and cost center.
billingCodeType
Code designating the method of code structure used for the billing code.  The default value is D, assigned by buyer. The value 02 indicates that it is assigned by Ariba.
city
The name of the city where the registrant resides.
country
The name of the country or region where the registrant resides.
email1
The registrant's primary e-mail or Web address.
email2
The registrant's secondary e-mail or Web address.
fax1
The registrant's primary facsimile number.
fax2
The registrant's secondary facsimile number.
firstName
The first name of the registrant.
lastName
(Required if the authentication mode is LDAP) The last name of the registrant. If the authentication mode is LDAP, this parameter is mandatory.
middleName
The middle name of the registrant.
organizationName
The name of the organization that the registrant represents.
organizationUnitName
The name of the unit within the organization that the registrant represents.
packageSuppression
personTitle
The title of the user whose address is being entered (for example, Dr., Rev., Mr. or Ms.).
phone1
The registrant's primary phone number.
phone1Type
The type of phone used for the registrant's primary phone number, for example TTY for hearing impaired, PCM for pulse-coded modulation, or CEL for mobile.  This is a field of 3 characters. 
phone2
The registrant's secondary phone number.
phone2Type
The type of phone used for the registrant's secondary phone number, for example TTY for hearing impaired, PCM for pulse-coded modulation, or CEL for mobile.  This is a field of 3 characters. 
publishPhone1
publishPhone2
shippingGeoCode
A shipping code based on geographical region, especially useful with tax software.
state
The name of the state, province, or equivalent where the registrant resides.
taxGeoCode
A tax code based on geographical region, especially useful with tax software.
zipCode
The ZIP or postal code of the registrant's address.

Example 1

The following example adds an organization named IBM under the Root Organization. The Root Organization has an organization entity ID of -2001.

    https://myhostname/webapp/wcs/stores/servlet/OrgEntityAdd?
    orgEntityName=IBM&orgEntityType=O&parentMemberId=-2001&URL=MallFrontView

Example 2

The following example adds an organization unit named Commerce, and associated address information for Commerce, under an existing organization with an entity ID of 7000000000000000001.

https://myhostname/webapp/wcs/stores/servlet/OrgEntityAdd?
    orgEntityName=Torolab&orgEntityType=OU&parentMemberId=7000000000000000001
    &address1=8200 Warden&city=Toronto&URL=MallFrontView

Behavior

Exception conditions