getCurrentManagedPlanGroup()

ManagedPlanGroup getCurrentManagedPlanGroup(string usn)

This method retrieves the details of the managed plan group that the specified subscription is in.

Parameters

usn: Format: string; Purpose: Specifies the USN of the subscription.

Results

This method returns a ManagedPlanGroup XML document.

If the given subscription does not belong to a managed plan group, then null is returned

There are no messages defined by this method.

Example: A returned ManagedPlanGroup XML document

This example shows a ManagedPlanGroup XML document.

<ManagedPlanGroup xmlns="http://xml.inomial.com/smile/2.xsd" xmlns="http://ws.inomial.com/smile.2">
  <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>

Faults

NoSuchItemException

This fault is returned when the USN provided does not have a corresponding subscription.

Java client syntax

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

usn: Purpose: Specifies the USN of the subscription.

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