getPoolReservationLinks()

PoolReservationLinks getPoolReservationLinks(string usn)

This method retrieves all active pool reservation links of a subscription.

Any expired or deleted links will not be returned.

Parameters

usn: Format: string; Purpose: Specifies the USN of the subscription for which to retrieve the reservation links.

Results

This method returns a PoolReservationLinks XML document containing a list of active pool reservation links. The document lists the pool reservation link ID, the link type, pool reservation information and the expiry, if applicable.

There are no messages defined by this method.

Example: A returned PoolReservationLinks XML document

This example shows a returned PoolReservationLinks XML document specifying all pool reservation links.

<PoolReservationLinks xmlns="http://xml.inomial.com/smile/2.xsd" xmlns="http://ws.inomial.com/smile.2">
  <Link>
    <LinkId>d8ef89fa-f53d-4b8e-8775-3a7227da063b</LinkId>
    <LinkType>Quarantine</LinkType>
    <Reservation>
      <ReservationId>0cc6b0e8-3c20-4606-8085-69c94170f0c3</ReservationId>
      <Start>10000100</Start>
      <End>10000199</End>
    </Reservation>
    <Expiry>2014-05-30T18:01:52.332+10:00</Expiry>
  </Link>
</PoolReservationLinks>

Faults

NoSuchItemException

This fault is returned when the specified USN does not match an account or subscription.

Java client syntax

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

usn: Purpose: Specifies the USN of the subscription for which to retrieve reservation links.

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