getManagedPlanGroups()

ManagedPlanGroupList getManagedPlanGroups(int sid)

This method retrieves a list of managed plan groups, and their choices, for the specified service.

Parameters

sid: Format: integer; Purpose: Specifies the SID of a service.

Results

This method returns a ManagedPlanGroupList XML document that contains the managed plan groups of the specified service.

There are no messages defined by this method.

Example: A returned ManagedPlanGroupList XML document

This example shows a ManagedPlanGroupList XML document.

<ManagedPlanGroupList xmlns="http://xml.inomial.com/smile/2.xsd" xmlns="http://ws.inomial.com/smile.2">
  <ManagedPlanGroup>
    <ManagedPlanGroupId>321</ManagedPlanGroupId>
    <Name>test.managedPlan</Name>
    <SID>628</SID>
    <UpgradeTiming>CurrentPeriod</UpgradeTiming>
    <CrossgradeTiming>Immediately</CrossgradeTiming>
    <DowngradeTiming>NextPeriod</DowngradeTiming>
    <PrePaymentRequiredFor>None</PrePaymentRequiredFor>
    <ManagedPlanChoices>
      <ManagedPlan>
        <ManagedPlanChoiceId>321</ManagedPlanChoiceId>
        <DisplayName>test.managedPlan.managedPlan1</DisplayName>
        <Description>test.managedPlan.managedPlan1</Description>
        <Position>1</Position>
        <ManagedPlanGroupRef>
          <ManagedPlanGroupId>321</ManagedPlanGroupId>
          <Name>test.managedPlan</Name>
        </ManagedPlanGroupRef>
        <ManagedPlanOptions/>
      </ManagedPlan>
      <ManagedPlan>
        <ManagedPlanChoiceId>322</ManagedPlanChoiceId>
        <DisplayName>test.managedPlan.managedPlan2</DisplayName>
        <Description>test.managedPlan.managedPlan2</Description>
        <Position>2</Position>
        <ManagedPlanGroupRef>
          <ManagedPlanGroupId>321</ManagedPlanGroupId>
          <Name>test.managedPlan</Name>
        </ManagedPlanGroupRef>
        <ManagedPlanOptions/>
      </ManagedPlan>
    </ManagedPlanChoices>
  </ManagedPlanGroup>
</ManagedPlanGroupList>

Faults

NoSuchItemException

This fault is returned when the SID provided does not have a corresponding service.

Java client syntax

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

sid: Purpose: Specifies the SID of a service.

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