addOrderToGroup()

OrderGroup addOrderToGroup(string orderGroupId, Order order)

This method adds the order specified to the order group.

Parameters

orderGroupId: Format: string; Purpose: Specifies the ID of the order group to which to add the order.
order: Format: Order XML; Purpose: Defines an Order XML document that specifies the order details to add to the order group.

Example: An Order XML document

This example shows an Order XML document that will add an ADSL package (61) on "Test Plan" (36) to the order group.

<Order xmlns="http://xml.inomial.com/smile/2.xsd">
  <Package>61</Package>
  <PackagePlan>36</PackagePlan>
  <OrderForm>
    <Object>
      <String name="username">joe@adsl.example.com</String>
    </Object>
  </OrderForm>
</Order>

Results

This method returns an OrderGroup XML document that contains 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.

<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>
    <Order>
      <OrderNumber>105110</OrderNumber>
      <Order>
        <Package>61</Package>
        <RequiresApproval>true</RequiresApproval>
        <AccountUSN>2142472105</AccountUSN>
        <PackagePlan>36</PackagePlan>
        <OrderForm>
          <Object>
            <String name="username">jie@adsl.example.com</String>
            <String name="account.name"></String>
          </Object>
        </OrderForm>
      </Order>
      <OrderedComponents>
        <Subscription>
          <USN>2142472303</USN>
          <ProvisionStatus>NotProvisioned</ProvisionStatus>
          <SuspendStatus>Active</SuspendStatus>
          <ActivateStatus>NotActivated</ActivateStatus>
          <EnableStatus>NotEnabled</EnableStatus>
          <SID>47</SID>
        </Subscription>
      </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.

Java client syntax

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

orderGroupId: Purpose: Specifies the ID of the order group to which to add the order.
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.