getContractsForService()

ContractDescriptionList getContractsForService(int sid)

This method returns a list of contracts defined against a particular service. This can be useful for presenting a set of available contracts to an end user. Note that there are other variables which may constrain the contract available to a subscription such as the plan.

Parameters

sid: Format: integer; Purpose: Specifies the ID of the service whose contracts to retrieve.

Results

This method returns a ContractDescriptionList XML document containing information about available contracts for the given service.

There are no messages defined by this method.

Example: A returned ContractDescriptionList XML document

This example shows a ContractDescriptionList XML document containing the available contracts for service 414.

<ContractDescriptionList xmlns="http:// xml.inomial.com/smile/2.xsd" xmlns="http://ws.inomial.com/ smile.2">
  <ContractDescription>
    <ContractId>465</ContractId>
    <ServiceId key="414">Spend Wise Voice Service</ServiceId>
    <Name>24 Months</Name>
    <BaseValue currency="AUD" formatted="$500.00">500</BaseValue>
    <PlanRecurringChargePercentage>0</PlanRecurringChargePercentage>
    <Duration unit="CalendarMonths">24</Duration>
    <GraceDays>2</GraceDays>
    <ValidFrom>2014-08-21+10:00</ValidFrom>
    <ValidTo>2014-08-21+10:00</ValidTo>
    <SetupFees/>
    <EarlyTerminationFee>    
      <ItemCode>002595</ItemCode>    
      <Name>Early termination charge</Name> 
      <UnitSize>1</UnitSize>    
      <ChargeGst>true</ChargeGst>   
      <Rate currency="AUD" formatted="$50.00">50</Rate>
    </EarlyTerminationFee>                
    <MinimumTerminationCharge currency="AUD" formatted="$0.00">0</MinimumTerminationCharge>                
    <MaximumTerminationCharge currency="AUD" formatted="$0.00">0</MaximumTerminationCharge>                
    <AllowedManagedPlanChanges>All</AllowedManagedPlanChanges>
  </ContractDescription>             
  <ContractDescription>
    <ContractId>464</ContractId> 
    <ServiceId key="414">Spend Wise Voice Service</ServiceId>
    <Name>12 Months</Name>                
    <BaseValue currency="AUD" formatted="$100.00">100</BaseValue>
    <PlanRecurringChargePercentage>0</PlanRecurringChargePercentage>
    <Duration unit="CalendarMonths">12</Duration> 
    <GraceDays>2</GraceDays> 
    <ValidFrom>2014-08-21+10:00</ValidFrom>
    <SetupFees/>
    <EarlyTerminationFee>
      <ItemCode>002594</ItemCode>
      <Name>Early termination charge</Name>    
      <UnitSize>1</UnitSize>
      <ChargeGst>true</ChargeGst>    
      <Rate currency="AUD" formatted="$12.00">12</Rate> 
    </EarlyTerminationFee>                 
    <MinimumTerminationCharge currency="AUD" formatted="$0.00">0</MinimumTerminationCharge>                
    <MaximumTerminationCharge currency="AUD" formatted="$0.00">0</MaximumTerminationCharge>                
    <Comments>Asd</Comments>
    <AllowedManagedPlanChanges>All</AllowedManagedPlanChanges>
  </ContractDescription>
</ContractDescriptionList>

Faults

NoSuchItemException

This fault is returned when the provided SID does not exist.

Java client syntax

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

sid: Purpose: Specifies the ID of the service whose contracts to retrieve.

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