getManagedPlanChoices()

ManagedPlanQuoteList getManagedPlanChoices(string usn)

This method retrieves a list of possible managed plan changes for the specified subscription.

Parameters

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

Results

This method returns a ManagedPlanQuoteList XML document that contains the possible managed plan choices for the specified subscription.

Warning: The quotes generated by this method are not stored. They are not visible in Smile and you cannot refer to them.

There are no messages defined by this method.

Example: A returned ManagedPlanQuoteList XML document

This example shows a ManagedPlanQuoteList XML document.

<ManagedPlanQuoteList xmlns="http://xml.inomial.com/smile/2.xsd" xmlns="http://ws.inomial.com/smile.2">
  <ManagedPlanQuote>
    <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>
    <EffectiveDate>2014-12-17+11:00</EffectiveDate>
    <Direction>Crossgrade</Direction>
    <Quote>
      <version>2.0</version>
      <transactionType>Quote</transactionType>
      <company>1</company>
      <usn>2142422415</usn>
      <transactionNumber>21429899</transactionNumber>
      <currency>AUD</currency>
      <amount>1.20</amount>
      <accountType>1</accountType>
      <gstAmount>0.11</gstAmount>
      <salesReportCategory>invoice</salesReportCategory>
      <formattedAmount currency="AUD" formatted="$1.20">1.20</formattedAmount>
      <formattedGstAmount currency="AUD" formatted="$0.11">0.11</formattedGstAmount>
      <unallocatedAmount>1.20</unallocatedAmount>
      <formattedUnallocatedAmount currency="AUD" formatted="$1.20">1.20</formattedUnallocatedAmount>
      <transactionDate>2014-12-17+11:00</transactionDate>
      <openDate>2014-12-17+11:00</openDate>
      <quoteNumber>21429899</quoteNumber>
      <createdByUsn>2142420781</createdByUsn>
      <transactionItem>
        <usn>2142422423</usn>
        <lineNumber>0</lineNumber>
        <itemCode>004692</itemCode>
        <chargeFrom>2014-12-17+11:00</chargeFrom>
        <chargeTo>2014-12-17+11:00</chargeTo>
        <description>Invoice item description</description>
        <quantity>1</quantity>
        <currency>AUD</currency>
        <amount>1.10</amount>
        <isGst>false</isGst>
        <chargeGst>true</chargeGst>
        <discount>0</discount>
        <count>0</count>
        <gstAmount>0.11</gstAmount>
        <salesReportCategory>unknown</salesReportCategory>
      </transactionItem>
      <transactionItem>
        <usn>2142422423</usn>
        <lineNumber>1</lineNumber>
        <itemCode>round</itemCode>
        <chargeFrom>2014-12-17+11:00</chargeFrom>
        <chargeTo>2014-12-17+11:00</chargeTo>
        <description>Rounding adjustment</description>
        <quantity>1</quantity>
        <currency>AUD</currency>
        <amount>-0.01</amount>
        <isGst>false</isGst>
        <chargeGst>true</chargeGst>
        <discount>0</discount>
        <count>0</count>
        <gstAmount>0</gstAmount>
        <salesReportCategory>round</salesReportCategory>
      </transactionItem>
      <transactionItem>
        <usn>2142422423</usn>
        <lineNumber>2</lineNumber>
        <itemCode>gst</itemCode>
        <chargeFrom>2014-12-17+11:00</chargeFrom>
        <chargeTo>2014-12-17+11:00</chargeTo>
        <description>Includes 10% GST</description>
        <quantity>1</quantity>
        <currency>AUD</currency>
        <amount>0.11</amount>
        <isGst>true</isGst>
        <chargeGst>false</chargeGst>
        <discount>0</discount>
        <count>0</count>
        <gstAmount>0.00</gstAmount>
        <salesReportCategory>gst</salesReportCategory>
      </transactionItem>
    </Quote>
  </ManagedPlanQuote>
  <ManagedPlanQuote>
    <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>
    <EffectiveDate>2014-12-01+11:00</EffectiveDate>
    <Direction>Upgrade</Direction>
    <Quote>
      <version>2.0</version>
      <transactionType>Quote</transactionType>
      <company>1</company>
      <usn>2142422415</usn>
      <transactionNumber>21429907</transactionNumber>
      <currency>AUD</currency>
      <amount>0.10</amount>
      <accountType>1</accountType>
      <gstAmount>0.01</gstAmount>
      <salesReportCategory>invoice</salesReportCategory>
      <formattedAmount currency="AUD" formatted="$0.10">0.10</formattedAmount>
      <formattedGstAmount currency="AUD" formatted="$0.01">0.01</formattedGstAmount>
      <unallocatedAmount>0.10</unallocatedAmount>
      <formattedUnallocatedAmount currency="AUD" formatted="$0.10">0.10</formattedUnallocatedAmount>     
      <transactionDate>2014-12-17+11:00</transactionDate>
      <openDate>2014-12-17+11:00</openDate>
      <quoteNumber>21429907</quoteNumber>
      <createdByUsn>2142420781</createdByUsn>
      <transactionItem>
        <usn>2142422423</usn>
        <lineNumber>0</lineNumber>
        <itemCode>004691</itemCode>
        <chargeFrom>2014-12-17+11:00</chargeFrom>
        <chargeTo>2014-12-17+11:00</chargeTo>
        <description>Invoice item description</description>
        <quantity>1</quantity>
        <currency>AUD</currency>
        <amount>0.10</amount>
        <isGst>false</isGst>
        <chargeGst>true</chargeGst>
        <discount>0</discount>
        <count>0</count>
        <gstAmount>0.01</gstAmount>
        <salesReportCategory>unknown</salesReportCategory>
      </transactionItem>
      <transactionItem>
        <usn>2142422423</usn>
        <lineNumber>1</lineNumber>
        <itemCode>round</itemCode>
        <chargeFrom>2014-12-17+11:00</chargeFrom>
        <chargeTo>2014-12-17+11:00</chargeTo>
        <description>Rounding adjustment</description>
        <quantity>1</quantity>
        <currency>AUD</currency>
        <amount>-0.01</amount>
        <isGst>false</isGst>
        <chargeGst>true</chargeGst>
        <discount>0</discount>
        <count>0</count>
        <gstAmount>0</gstAmount>
        <salesReportCategory>round</salesReportCategory>
      </transactionItem>
      <transactionItem>
        <usn>2142422423</usn>
        <lineNumber>2</lineNumber>
        <itemCode>gst</itemCode>
        <chargeFrom>2014-12-17+11:00</chargeFrom>
        <chargeTo>2014-12-17+11:00</chargeTo>
        <description>Includes 10% GST</description>
        <quantity>1</quantity>
        <currency>AUD</currency>
        <amount>0.01</amount>
        <isGst>true</isGst>
        <chargeGst>false</chargeGst>
        <discount>0</discount>
        <count>0</count>
        <gstAmount>0.00</gstAmount>
        <salesReportCategory>gst</salesReportCategory>
      </transactionItem>
    </Quote>
  </ManagedPlanQuote>
</ManagedPlanQuoteList>

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.GetManagedPlanChoices 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.