getPlanSchedules()

PlanSchedules getPlanSchedules(string usn)

This method returns information about each plan a subscription uses throughout its lifecycle. Each plan is described by a plan schedule, which specifies the plan that a subscription uses at a given point in time.

Use this method to retrieve information about a subscription's current plan, plan changes scheduled in the future and plan changes that occurred in the past.

Parameters

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

Results

This method returns a PlanSchedules XML document that contains information about each plan the subscription uses throughout its lifecycle. The plans are defined by plan schedule items, which specify when the subscription begins using each plan. The PlanSchedules XML document lists the plan schedule items in chronological order.

There are no messages defined by this method.

Example: A returned PlanSchedules XML document

This example shows a PlanSchedules XML document that contains two plan schedule items. These items show that the subscription began using the Silver plan on 1 January 2011, and then used the Gold plan from 1 July 2011.

<PlanSchedules xmlns="http://xml.inomial.com/smile/2.xsd">
  <PlanSchedule>
    <PlanScheduleType>1</PlanScheduleType>
    <PlanScheduleItem>
      <PlanCode>Silver</PlanCode>
      <PlanScheduleType>1</PlanScheduleType>
      <Start>2011-01-01T00:00:00+11:00</Start>
      <Options>
        <Object>
          <Boolean name="staticIp">true</Boolean>
        </Object>
      </Options>
    </PlanScheduleItem>
    <PlanScheduleItem>
      <PlanCode>Gold</PlanCode>
      <PlanScheduleType>1</PlanScheduleType>
      <Start>2011-07-01T00:00:00+11:00</Start>
      <Options>
        <Object>
          <Boolean name="staticIp">true</Boolean>
        </Object>
      </Options>
    </PlanScheduleItem>
  </PlanSchedule>
</PlanSchedules>

Faults

NoSuchItemException

This fault is returned when the subscription does not exist.

Java client syntax

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

usn: Purpose: Specifies the USN of the subscription associated with the plans.

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