get()

Subscription get(string usn)

This method searches by USN for a subscription and returns an XML document with detailed information about the subscription's properties and status.

You can call this method at any point after the subscription order is entered.

Parameters

usn: Format: string; Purpose: Specifies the USN of the subscription to retrieve.

Results

This method returns a Subscription XML document that contains detailed information about the subscription's properties and status.

There are no messages defined by this method.

Example: A returned Subscription XML document

This example shows a Subscription XML document. The document contains subscription properties (username, given name, family name and number of phone lines) and the subscription's status (provisioned, not suspended, activated and enabled).

Note: Smile uses the key attribute on the <Timezone> and <Costcentre> elements as an internal identifier.

<Subscription xmlns="http://xml.inomial.com/smile/2.xsd">
  <USN>120398123</USN>
  <SID>15</SID>
  <ServiceName>VOIP</ServiceName>
  <Parent>1204921324</Parent>
  <Properties>
    <Object>
      <String name="username">+61355501256</String>
      <String name="contactGiven">Joe</String>
      <String name="contactFamily">Smith</String>
      <Integer name="phoneLines">13</Integer>
    </Object>
  </Properties>
  <ProvisionStatus>Provisioned</ProvisionStatus>
  <SuspendStatus>Active</SuspendStatus>
  <ActivateStatus>Activated</ActivateStatus>
  <EnableStatus>Enabled</EnableStatus>
  <InvoicingCycle>
    <CycleType>Anniversary</CycleType>
    <CycleDay>24</CycleDay>
  </InvoicingCycle>
  <RatingCycle>
    <CycleType>Anniversary</CycleType>
    <CycleDay>24</CycleDay>
  </RatingCycle>
  <Timezone key="19">Australia/Sydney</Timezone>
  <CostCentre key="1">Example cost centre</CostCentre>
</Subscription>

Faults

GetSubscriptionException

This fault is returned when the subscription does not exist or the caller does not have permission to access the subscription.

Java client syntax

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

usn: Purpose: Specifies the USN of the subscription to retrieve.

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