get()

Account get(string usn)

This method searches by USN for an account and returns an XML document with detailed information about the account and its associated subscriptions.

Parameters

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

Results

This method returns an Account XML document that contains detailed information about the account and its associated subscriptions.

There are no messages defined by this method.

Example: A returned Account XML document

This example shows an Account XML document. The document contains some account properties (for example, billName and emailAddress) and the subscriptions linked to the account.

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

<Account xmlns="http://xml.inomial.com/smile/2.xsd">
  <USN>129512142</USN>
  <Invoicee>
    <InvoiceeUsn>2142421482</InvoiceeUsn>
  </Invoicee>
  <InvoicingCycle>
    <CycleType>Anniversary</CycleType>
    <CycleDay>20</CycleDay>
  </InvoicingCycle>
  <RatingCycle>
    <CycleType>Anniversary</CycleType>
    <CycleDay>20</CycleDay>
  </RatingCycle>
  <Timezone key="19">Australia/Sydney</Timezone>
  <AccountTerms key="1">Default terms</AccountTerms>
  <CostCentre key="105">Example cost centre</CostCentre>
  <Properties>
    <Object>
      <String name="billName">Smith</String>
      <String name="billNumber">60</String>
      <String name="billPostCode">3000</String>
      <String name="billState">VIC</String>
      <String name="billSuburb">Melbourne</String>
      <String name="billType">ST</String>
      <String name="emailAddress">demo@example.com</String>
      <String name="name">Example Company Pty Ltd</String>
      <String name="workPhone">+61355501256</String>
    </Object>
  </Properties>
  <Subscriptions>
    <Subscription>
      <USN>1249871232</USN>
      <SID>17</SID>
      <ServiceName>ADSL</ServiceName>
      <Parent>129512142</Parent>
      <Properties>
        <Object>
          <String name="username">+61355501256</String>
        </Object>
      </Properties>
      <ProvisionStatus>Provisioned</ProvisionStatus>
      <SuspendStatus>Active</SuspendStatus>
      <ActivateStatus>Activated</ActivateStatus>
      <EnableStatus>Enabled</EnableStatus>
      <InvoicingCycle>
        <CycleType>Anniversary</CycleType>
        <CycleDay>20</CycleDay>
      </InvoicingCycle>
      <RatingCycle>
        <CycleType>Anniversary</CycleType>
        <CycleDay>20</CycleDay>
      </RatingCycle>
      <Timezone key="19">Australia/Sydney</Timezone>
    </Subscription>
  </Subscriptions>
</Account>

Faults

AccountException

This fault is returned when the account does not exist or cannot be retrieved, or when the caller does not have permission to access the account.

Java client syntax

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

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

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