getServicePlans()

PlanConfigurations getServicePlans(int sid, string usn, date timestamp)

This method returns a list of published plans available against a service or plans available to subscriptions on an accounts for a service. Available plans may also be listed at a specific date and time.

Parameters

sid: Format: integer; Purpose: Specifies the service ID for which to return available plans.
usn: Format: string; Purpose: (Optional) Specifies the USN of the account for which to return available plans.
timestamp: Format: date; Purpose: (Optional) Specifies a specific point in time at which to return available plans.

Results

This method returns a list of published plans available against a service or plans available to subscriptions on an account for a service. The private plans of an account for the specified service will be included in the list when account USN is specified. If you do not specify a date and time, it will return a list of valid plans at the time the request is sent.

There are no messages defined by this method.

Example: A returned PlanConfigurationsType XML document

This example shows a PlanConfigurationsType XML document when service ID, and optional account USN and date and time are given as parameters. Each <PlanConfiguration> element contains information about the plan.

<PlanConfigurations xmlns:ns2="http://xml.inomial.com/smile/2.xsd" xmlns:ns3="http://ws.inomial.com/smile.2">
  <PlanConfiguration>
    <Plan>tp858_1</Plan>
    <PlanName>Test plan 858 _1</PlanName>
    <Company>1</Company>
    <RecurringCharges/>
    <PlanOptions/>
    <ChargingRules/>
    <IncludedValuePools>
      <IncludedValuePool id="2455">
        <Name>Cap</Name>
        <ValueIncTax currency="AUD" formatted="$0.00">0.00</ValueIncTax>
      </IncludedValuePool>
    </IncludedValuePools>
  </PlanConfiguration>
  <PlanConfiguration>
    <Plan>tp858_2</Plan>
    <PlanName>Test plan 858 _2</PlanName>
    <Company>1</Company>
    <RecurringCharges/>
    <PlanOptions/>
    <ChargingRules/>
    <IncludedValuePools>
      <IncludedValuePool id="2457">
        <Name>Cap</Name>
        <ValueIncTax currency="AUD" formatted="$0.00">0.00</ValueIncTax>
      </IncludedValuePool>
    </IncludedValuePools>
  </PlanConfiguration>
  <PlanConfiguration>
    <Plan>tpp859</Plan>
    <PlanName>Test private plan 859</PlanName>
    <Company>1</Company>
    <RecurringCharges/>
    <PlanOptions/>
    <ChargingRules/>
    <IncludedValuePools>
      <IncludedValuePool id="2467">
        <Name>Cap</Name>
        <ValueIncTax currency="AUD" formatted="$0.00">0.00</ValueIncTax>
      </IncludedValuePool>
    </IncludedValuePools>
  </PlanConfiguration>
</PlanConfigurations>

Faults

NoSuchItemException

This fault is returned when the specified USN does not match a subscription.

Java client syntax

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

sid: Purpose: Specifies the service ID for which to return available plans.
usn: Purpose: (Optional) Specifies the USN of the account for which to return available plans.
timestamp: Purpose: (Optional) Specifies a specific point in time at which to return available plans.

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