getSubscriptionContracts()

SubscriptionContractList getSubscriptionContracts(string usn)

This method returns a lists of all contracts for a given subscription.

Parameters

usn: Format: string; Purpose: Specifies the USN of the subscription whose contracts to return.

Results

This method returns a SubscriptionContractList XML document containing information about all contracts associated with a subscription.

There are no messages defined by this method.

Example: A returned SubscriptionContractList XML document

This example shows a SubscriptionContractList XML document containing information about contracts associated with subscription 2142422431.

<SubscriptionContractList xmlns="http://xml.inomial.com/smile/2.xsd" xmlns="http://ws.inomial.com/smile.2">
  <SubscriptionContract>
    <SubscriptionContractId>474</SubscriptionContractId>
    <Contract key="465">24 Months</Contract>
    <USN>2142422431</USN>
    <EarlyTerminationCharge currency="AUD" formatted="$50.00">50</EarlyTerminationCharge>
    <StartDate>2014-08-21+10:00</StartDate>
    <EndDate>2016-08-20+10:00</EndDate>
    <ContractValue currency="AUD" formatted="$500.00">500</ContractValue>
    <MinimumTerminationCharge currency="AUD" formatted="$0.00">0</MinimumTerminationCharge>
    <MaximumTerminationCharge currency="AUD" formatted="$0.00">0</MaximumTerminationCharge>
    <Terminated>2014-08-22+10:00</Terminated>
    <ContractedPlanScheduleItem>1201</ContractedPlanScheduleItem>
  </SubscriptionContract>
  <SubscriptionContract>
    <SubscriptionContractId>475</SubscriptionContractId>
    <Contract key="465">24 Months</Contract>
    <USN>2142422431</USN>
    <EarlyTerminationCharge currency="AUD" formatted="$50.00">50</EarlyTerminationCharge>
    <StartDate>2014-08-23+10:00</StartDate>
    <EndDate>2015-08-22+10:00</EndDate>
    <ContractValue currency="AUD" formatted="$500.00">500</ContractValue>
    <MinimumTerminationCharge currency="AUD" formatted="$0.00">0</MinimumTerminationCharge>
    <MaximumTerminationCharge currency="AUD" formatted="$0.00">0</MaximumTerminationCharge>
    <Terminated>2014-09-30+10:00</Terminated>
    <ContractedPlanScheduleItem>1201</ContractedPlanScheduleItem>
  </SubscriptionContract>
  <SubscriptionContract>
    <SubscriptionContractId>473</SubscriptionContractId>
    <Contract key="464">12 Months</Contract>
    <USN>2142422431</USN>
    <EarlyTerminationCharge currency="AUD" formatted="$120,000.00">120000</EarlyTerminationCharge>
    <StartDate>2020-08-21+10:00</StartDate>
    <EndDate>2030-08-20+10:00</EndDate>
    <ContractValue currency="AUD" formatted="$100.00">100</ContractValue>
    <MinimumTerminationCharge currency="AUD" formatted="$0.00">0</MinimumTerminationCharge>
    <MaximumTerminationCharge currency="AUD" formatted="$0.00">0</MaximumTerminationCharge>
    <ContractedPlanScheduleItem>1201</ContractedPlanScheduleItem>
  </SubscriptionContract>
</SubscriptionContractList>

Faults

NoSuchItemException

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

InvalidRequestException

This fault is returned when the request is invalid.

Java client syntax

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

usn: Purpose: Specifies the USN of the subscription whose contracts to return.

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