getPlanSchedule()

ManagedPlanSchedule getPlanSchedule(string usn)

This method retrieves the current and future managed plan changes for the specifies subscription.

This method will fail if custom plans are scheduled in these periods .

Parameters

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

Results

This method returns a ManagedPlanSchedule XML document with that contains current and future managed plans.

There are no messages defined by this method.

Example: A returned ManagedPlanSchedule XML document

This example shows a ManagedPlanSchedule XML document.

<ManagedPlanSchedule xmlns="http://xml.inomial.com/smile/2.xsd" xmlns="http://ws.inomial.com/smile.2">
  <ManagedPlanScheduleItem>
    <Start>2014-12-01T00:00:00.000+11:00</Start>
    <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>
  </ManagedPlanScheduleItem>
</ManagedPlanSchedule>

Example: A returned ManagedPlanSchedule XML document

This example shows a ManagedPlanSchedule XML document.

<ManagedPlanSchedule xmlns+"http://xml.inomial.com/smile/2.xsd" xmlns="http://ws.inomial.com/smile.2">
  <ManagedPlanScheduleItem>
    <Start>2014-12-01T00:00:00.000+11:00</Start>
    <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>
  </ManagedPlanScheduleItem>
</ManagedPlanSchedule>

Faults

NoSuchItemException

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

PlanChangeUnavailableException

This fault is returned when the subscription is not eligible for plan changes. For example, if the subscription does not belong to a plan change group.

PlanChangeException

This fault is returned when an internal error or configuration problem prevents the request from being processed.

Java client syntax

java -cp build/smilewsv2-client.jar [options]
 com.inomial.smile.client.v2.examples.GetPlanSchedule 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.