getLink()

PoolReservationLink getLink(string linkId)

This method retrieves the details of a link by ID.

Parameters

linkId: Format: string; Purpose: Specifies the ID of the link to retrieve.

Results

This method returns a PoolReservationLink XML document containing information about the reservation link.

There are no messages defined by this method.

Example: A returned PoolReservationLink XML document

This example shows a PoolReservationLink XML document that contains information about the reservation link.

<PoolReservationLink xmlns="http://xml.inomial.com/smile/2.xsd" xmlns="http://ws.inomial.com/smile.2">
  <LinkId>a9d8f38e-f9da-4f82-8396-4a0997b72435</LinkId>
  <LinkType>Allocation</LinkType>
  <Reservation>
    <ReservationId>732b30ff-824b-4a0e-9eea-691e280f2d5e</ReservationId>
    <Start>0399990000</Start>
    <End>0399999999</End>
  </Reservation>
</PoolReservationLink>

Faults

NoSuchItemException

This fault is returned when the link ID does not exist.

Java client syntax

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

linkId: Purpose: Specifies the ID of the link to retrieve.

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