unlink()

PoolReservationLink unlink(string linkId)

This method removes a resource link.

If the link ID is a concrete link (Pre-Allocation or Allocation) then a Quarantine link will be created and returned if Smile is configured to do so.

Parameters

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

Results

This method returns a quarantine link if one is created, otherwise no results are returned.

Smile emits a LinkDeallocation message when Smile removes the resource link.

Example: A returned PoolReservationLink XML document

This example shows a PoolReservationLink XML document that contains a quarantine link type.

<PoolReservationLink xmlns="http://xml.inomial.com/smile/2.xsd" xmlns="http://ws.inomial.com/smile.2">
  <LinkId>e55fe410-5d6f-43f3-bbf1-51bafb2f07fe</LinkId>
  <LinkType>Quarantine</LinkType>
  <Reservation>
    <ReservationId>732b30ff-824b-4a0e-9eea-691e280f2d5e</ReservationId>
    <Start>0399990000</Start>
    <End>0399999999</End>
  </Reservation>
  <Expiry>2015-04-09T13:34:13.073+10:00</Expiry>
</PoolReservationLink>

Faults

NoSuchItemException

This fault is returned when the given linkId does not exist.

Java client syntax

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

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

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