createOrderGroup()

OrderGroup createOrderGroup(Order initialOrder)

This method creates a new order group with the initial order provided. The order will not be placed until placeOrderGroup() is called.

Parameters

initialOrder: Format: Order XML; Purpose: Defines an Order XML document that specifies the initial order to create the order group. If you wish to order a new account, this initial order must be for the account.

Example: An Order XML document

This example shows an Order XML document that will order Package 258 to create a new account for Joe Smith. The account will not be created until the order group is placed.

<Order xmlns="http://xml.inomial.com/smile/2.xsd">
  <Package>258</Package>
  <OrderForm>
    <Object>
      <String name="account.name">Joe Smith</String>
      <String name="email.address">joe@example.com</String>
    </Object>
  </OrderForm>
</Order>

Results

This method returns an OrderGroup XML document containing information about the order group.

There are no messages defined by this method.

Example: A returned OrderGroup XML document

This example shows an OrderGroup XML document containing an order group with a new order group number, a new account USN and the details of the order.

<OrderGroup xmlns="http://xml.inomial.com/smile/2.xsd" xmlns="http://ws.inomial.com/smile.2">
  <OrderGroupNumber>105090</OrderGroupNumber>
  <AccountUSN>2142472105</AccountUSN>
  <Orders>
    <Order>
      <OrderNumber>105090</OrderNumber>
      <Order>
        <Package>4740</Package>
        <RequiresApproval>true</RequiresApproval>
        <AccountUSN>2142472105</AccountUSN>
        <OrderForm>
          <Object>
            <String name="email.address">joe@example.com</String>
            <String name="account.name">Joe Smith</String>
          </Object>
        </OrderForm>
      </Order>
      <OrderedComponents>
        <Account>
          <USN>2142472105</USN>
          <ProvisionStatus>NotProvisioned</ProvisionStatus>
          <SuspendStatus>Active</SuspendStatus>
          <ActivateStatus>NotActivated</ActivateStatus>
          <EnableStatus>NotEnabled</EnableStatus>
        </Account>
      </OrderedComponents>
    </Order>
  </Orders>
</OrderGroup>

Faults

NoSuchItemException

This fault is returned when one of the references in the order group, for example, package, account or package plan, does not exist.

OrderException

This fault is returned when there is a problem with the order provided.

Java client syntax

java -cp build/smilewsv2-client.jar [options]
 com.inomial.smile.client.v2.examples.CreateOrderGroup filename

filename: Purpose: Defines the filename of the Order XML document.

Note: For more information about the Java client and the options it accepts, see Java client syntax.