getSubscriptionContractById()

SubscriptionContract getSubscriptionContractById(string subscriptionContractId)

This method returns a subscription contract by its ID.

Parameters

subscriptionContractId: Format: string; Purpose: Specifies the ID of the subscription contract to retrieve.

Results

This method returns a SubscriptionContract XML document containing information about the subscription contract.

There are no messages defined by this method.

Example: A returned SubscriptionContract XML document

This example shows a SubscriptionContract XML document for subscription contract 476.

<SubscriptionContract xmlns="http:// xml.inomial.com/smile/2.xsd" xmlns="http://ws.inomial.com/smile.2">
  <SubscriptionContractId>476</SubscriptionContractId>
  <Contract key="399">12 Month</Contract>
  <USN>2142422589</USN>
  <EarlyTerminationCharge currency="AUD" formatted="$0.00">0</EarlyTerminationCharge>
  <StartDate>2014-08-28+10:00</StartDate>
  <EndDate>2015-08-27+10:00</EndDate>
  <ContractValue currency="AUD" formatted="$360.00">360.000000</ContractValue>
  <MinimumTerminationCharge currency="AUD" formatted="$0.00">0</MinimumTerminationCharge>
  <MaximumTerminationCharge currency="AUD" formatted="$0.00">0</MaximumTerminationCharge>
</SubscriptionContract>

Faults

ItemNotFoundException

This fault is returned when the given subscription contract ID 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.GetSubscriptionContractById
 subscriptionContractID

subscriptionContractID: Purpose: Specifies the ID of the subscription contract to retrieve.

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