getPlanConfiguration()

PlanConfiguration getPlanConfiguration(int company, string plan)

This method returns the plan configuration details of a service. Details returned include recurring charges, plan options, plan rules, setup charge and included value pools.

Note: The plan has to belong to a service.

Parameters

company: Format: integer; Purpose: Specifies the company that the plan belongs to.
plan: Format: string; Purpose: Specifies the plan's code.

Results

This method returns a PlanConfiguration XML document with the plan configuration details.

There are no messages defined by this method.

Example: A returned PlanConfiguration XML document

This example shows PlanConfiguration XML document containing the plan configuration details.

<PlanConfiguration>
  <RecurringCharges>
    <RecurringCharge id="635">
      <ChargeQuantity>1</ChargeQuantity>
      <Frequency type="Rating Periods">1</Frequency>
      <WhenToCharge>In Advance</WhenToCharge>
      <AdvancePeriods>1</AdvancePeriods>
      <ProRataAction>Pro-Rata</ProRataAction>
      <MinProRataDays>1</MinProRataDays>
      <LineItemDescription id="2629">
        <Company>1</Company>
        <ItemCode>002048</ItemCode>
        <Name>recurring charge</Name>
        <UnitSize>1</UnitSize>
        <ChargeGst>true</ChargeGst>
        <Rate currency="AUD" formatted="$10.00">10</Rate>
        <ReportingCategory>
          <Company>1</Company>
          <ReportingCode>unknown</ReportingCode>
          <Name>Uncategorised Transaction</Name>
          <Id>10</Id>
        </ReportingCategory>
        <Currency>AUD</Currency>
        <Object/>
      </LineItemDescription>
    </RecurringCharge>
  </RecurringCharges>
  <PlanOptions/>
  <ChargingRules>
    <ChargingRule id="1118">
      <ChargeType key="866">test.planChange.overrideTariffs Flagfall</ChargeType>
      <LineItemDescription id="2581">
        <Company>1</Company>
        <ItemCode>002000</ItemCode>
        <Name>test.planChange.overrideTariffs Flagfall</Name>
        <UnitSize>1</UnitSize>
        <ChargeGst>true</ChargeGst>
        <Rate currency="AUD" formatted="$0.00">0</Rate>
        <ReportingCategory>
          <Company>1</Company>
          <ReportingCode>unknown</ReportingCode>
          <Name>Uncategorised Transaction</Name>
          <Id>10</Id>
        </ReportingCategory>
        <Currency>AUD</Currency>
        <Object/>
      <LineItemDescription>
      <RateSource>
        <RetailMarkup>100.00</RetailMarkup>
      </RateSource>
      <Constraints>
        <DaysOfWeek all="true"/>
      </Constraints>
      <PrepaidRules/>
      <IncludedValuePoolRef key="807">test.planChange.overrideTariffs</IncludedValuePoolRef>
      <AllowOverride>false</AllowOverride>
    </ChargingRule>
    <ChargingRule id="1119">
      <ChargeType key="867">test.planChange.overrideTariffs Timed</ChargeType>
      <LineItemDescription id="2582">
        <Company>1</Company>
        <ItemCode>002001</ItemCode>
        <Name>test.planChange.overrideTariffs Timed</Name>
        <UnitSize>1</UnitSize>
        <ChargeGst>true</ChargeGst>
        <Rate currency="AUD" formatted="$0.00">0</Rate>
        <ReportingCategory>
          <Company>1</Company>
          <ReportingCode>unknown</ReportingCode>
          <Name>Uncategorised Transaction</Name>
          <Id>10</Id>
        </ReportingCategory>
        <Currency>AUD</Currency>
        <Object/>
      </LineItemDescription>
      <RateSource>
        <FixedCharge>
          <Rate currency="AUD" formatted="$0.00">0</Rate>
          <PerUnit unitQuantity="1">Second</PerUnit>
        </FixedCharge>
      </RateSource>
      <Constraints>
        <DaysOfWeek all="true"/>
      </Constraints>
      <PrepaidRules/>
      <IncludedValuePoolRef key="807">test.planChange.overrideTariffs</IncludedValuePoolRef>
      <AllowOverride>false</AllowOverride>
    </ChargingRule>
    <ChargingRule id="1122">
      <ChargeType key="868">test.planChange.overrideTariffs Pages</ChargeType>
      <LineItemDescription id="2585">
        <Company>1</Company>
        <ItemCode>002004</ItemCode>
        <Name>test.planChange.overrideTariffs Pages</Name>
        <UnitSize>1</UnitSize>
        <ChargeGst>true</ChargeGst>
        <Rate currency="AUD" formatted="$1.00">1.0</Rate>
        <ReportingCategory>
          <Company>1</Company>
          <ReportingCode>unknown</ReportingCode>
          <Name>Uncategorised Transaction</Name>
          <Id>10</Id>
        </ReportingCategory>
        <Currency>AUD</Currency>
        <Object/>
      </LineItemDescription>
      <RateSource>
        <FixedCharge>
          <Rate currency="AUD" formatted="$1.00">1.0</Rate>
          <PerUnit unitQuantity="1">Page</PerUnit>
        </FixedCharge>
      </RateSource>
      <Constraints>
        <DaysOfWeek all="true"/>
      </Constraints>
      <PrepaidRules/>
      <IncludedValuePoolRef key="807">test.planChange.overrideTariffs</IncludedValuePoolRef>
      <AllowOverride>false</AllowOverride>
    <ChargingRule>
    <ChargingRule id="1120">
      <ChargeType key="869">test.planChange.overrideTariffs bytes in</ChargeType>
      <LineItemDescription id="2583">
        <Company>1</Company>
        <ItemCode>002002</ItemCode>
        <Name>test.planChange.overrideTariffs bytes in</Name>
        <UnitSize>1</UnitSize>
        <ChargeGst>true</ChargeGst>
        <Rate currency="AUD" formatted="$1.00">1.0</Rate>
        <ReportingCategory>
          <Company>1</Company>
          <ReportingCode>unknown</ReportingCode>
          <Name>Uncategorised Transaction</Name>
          <Id>10</Id>
        </ReportingCategory>
        <Currency>AUD</Currency>
        <Object/>
      </LineItemDescription>
      <RateSource>
        <FixedCharge>
          <Rate currency="AUD" formatted="$1.00">1.0</Rate>
          <PerUnit unitQuantity="1">Bytes</PerUnit>
        </FixedCharge>
      </RateSource>
      <Constraints>
        <DaysOfWeek all="true"/>
      </Constraints>
      <PrepaidRules/>
      <IncludedValuePoolRef key="807">test.planChange.overrideTariffs</IncludedValuePoolRef>
      <AllowOverride>false</AllowOverride>
    </ChargingRule>
    <ChargingRule id="1121">
      <ChargeType key="870">test.planChange.overrideTariffs bytes out</ChargeType>
      <LineItemDescription id="2584">
        <Company>1</Company>
        <ItemCode>002003</ItemCode>
        <Name>test.planChange.overrideTariffs bytes out</Name>
        <UnitSize>1</UnitSize>
        <ChargeGst>true</ChargeGst>
        <Rate currency="AUD" formatted="$1.00">1.0</Rate>
        <ReportingCategory>
          <Company>1</Company>
          <ReportingCode>unknown</ReportingCode>
          <Name>Uncategorised Transaction</Name>
          <Id>10</Id>
        </ReportingCategory>
        <Currency>AUD</Currency>
        <Object/>
      </LineItemDescription>
      <RateSource>
        <FixedCharge>
          <Rate currency="AUD" formatted="$1.00">1.0</Rate>
          <PerUnit unitQuantity="1">Bytes</PerUnit>
        </FixedCharge>
      </RateSource>
      <Constraints>
        <DaysOfWeek all="true"/>
      </Constraints>
      <PrepaidRules/>
      <IncludedValuePoolRef key="807">test.planChange.overrideTariffs</IncludedValuePoolRef>
      <AllowOverride>false</AllowOverride>
    </ChargingRule>
    <ChargingRule id="1123">
      <ChargeType key="871">test.planChange.overrideTariffs rate</ChargeType>
      <LineItemDescription id="2586">
        <Company>1</Company>
        <ItemCode>002005</ItemCode>
        <Name>test.planChange.overrideTariffs rate</Name>
        <UnitSize>1</UnitSize>
        <ChargeGst>true</ChargeGst>
        <Rate currency="AUD" formatted="$1.00">1.0</Rate>
        <ReportingCategory>
          <Company>1</Company>
          <ReportingCode>unknown</ReportingCode>
          <Name>Uncategorised Transaction</Name>
          <Id>10</Id>
        </ReportingCategory>
        <Currency>AUD</Currency>
        <Object/>
      </LineItemDescription>
      <RateSource>
        <FixedCharge>
          <Rate currency="AUD" formatted="$1.00">1.0</Rate>
          <PerUnit unitQuantity="1">Bytes/s</PerUnit>
        </FixedCharge>
      </RateSource>
      <Constraints>
        <DaysOfWeek all="true"/>
      </Constraints>
      <PrepaidRules/>
      <IncludedValuePoolRef key="807">test.planChange.overrideTariffs</IncludedValuePoolRef>
      <AllowOverride>false</AllowOverride>
    </ChargingRule>
    <ChargingRule id="1124">
      <ChargeType key="872">test.planChange.overrideTariffs bytes sent rate</ChargeType>
      <LineItemDescription id="2587">
        <Company>1</Company>
        <ItemCode>002006</ItemCode>
        <Name>test.planChange.overrideTariffs bytes sent rate</Name>
        <UnitSize>1</UnitSize>
        <ChargeGst>true</ChargeGst>
        <Rate currency="AUD" formatted="$1.00">1.0</Rate>
        <ReportingCategory>
          <Company>1</Company>
          <ReportingCode>unknown</ReportingCode>
          <Name>Uncategorised Transaction</Name>
          <Id>10</Id>
        </ReportingCategory>
        <Currency>AUD</Currency>
        <Object/>
      </LineItemDescription>
      <RateSource>
        <FixedCharge>
          <Rate currency="AUD" formatted="$1.00">1.0</Rate>
          <PerUnit unitQuantity="1">Bytes/s</PerUnit>
        </FixedCharge>
      </RateSource>
      <Constraints>
        <DaysOfWeek all="true"/>
      </Constraints>
      <PrepaidRules/>
      <IncludedValuePoolRef key="807">test.planChange.overrideTariffs</IncludedValuePoolRef>
      <AllowOverride>false</AllowOverride>
    </ChargingRule>
    <ChargingRule id="1125">
      <ChargeType key="873">test.planChange.overrideTariffs bytes received rate</ChargeType>
      <LineItemDescription id="2588">
        <Company>1</Company>
        <ItemCode>002007</ItemCode>
        <Name>test.planChange.overrideTariffs bytes received rate</Name>
        <UnitSize>1</UnitSize>
        <ChargeGst>true</ChargeGst>
        <Rate currency="AUD" formatted="$1.00">1.0</Rate>
        <ReportingCategory>
          <Company>1</Company>
          <ReportingCode>unknown</ReportingCode>
          <Name>Uncategorised Transaction</Name>
          <Id>10</Id>
        </ReportingCategory>
        <Currency>AUD</Currency>
        <Object/>
      </LineItemDescription>
      <RateSource>
        <FixedCharge>
          <Rate currency="AUD" formatted="$1.00">1.0</Rate>
          <PerUnit unitQuantity="1">Bytes/s</PerUnit>
        </FixedCharge>
      </RateSource>
      <Constraints>
        <DaysOfWeek all="true"/>
      </Constraints>
      <PrepaidRules/>
      <IncludedValuePoolRef key="807">test.planChange.overrideTariffs</IncludedValuePoolRef>
      <AllowOverride>false</AllowOverride>
    </ChargingRule>
  </ChargingRules>
  <IncludedValuePools>
    <IncludedValuePool id="805">
      <Name>Cap</Name>
      <ValueIncTax currency="AUD" formatted="$0.00">0.00</ValueIncTax>
    </IncludedValuePool>
    <IncludedValuePool id="807">
      <Name>test.planChange.overrideTariffs</Name>
      <ValueIncTax currency="AUD" formatted="$0.00">0.00</ValueIncTax>
    </IncludedValuePool>
  </IncludedValuePools>
</PlanConfiguration>

Faults

NoSuchItemException

This fault is returned when the plan specified does not exist.

Java client syntax

java -cp build/smilewsv2-client.jar [options]
 com.inomial.smile.client.v2.examples.GetPlanConfiguration company
 plan

company: Purpose: Specifies the company that the plan belongs to.
plan: Purpose: Specifies the plan's code.

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