createLinkToReservation()

PoolReservationLink createLinkToReservation(string reservationId, LinkType linkType, BackLink backLink)

This method adds a link to an existing reservation.

Parameters

reservationId: Format: string; Purpose: Specifies the ID of the reservation to link to.
linkType: Format: LinkType XML; Purpose: Defines a LinkType XML document that specifies the link type for the initial link. LinkType has a value of Temporary, PreAllocation, Allocation or Quarantine.
backLink: Format: BackLink XML; Purpose: (Optional) Defines a BackLink XML document that specifies a backlink identifying the owner of the link.

Results

This method returns a PoolReservationLink XML document containing the a link to the new reservation.

There are no messages defined by this method.

Example: A returned PoolReservationLink XML document

This example shows a PoolReservationLink XML document returned after adding an Allocation link type to a reservation.

<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

InvalidRequestException

This fault is returned when a required field is not specified, linkType is invalid, or the reservation is no longer active.

NoSuchItemException

This fault is returned when one of the referenced objects does not exist.

Java client syntax

java -cp build/smilewsv2-client.jar [options] com.inomial.smile.client.v2.examples.CreateLinkToReservation
 reservationId filename [backLinkType] [backLinkKey]

reservationId: Purpose: Specifies the ID of the reservation to link to.
filename: Purpose: Defines the filename of the LinkType XML document.
backLinkType: Purpose: (Optional) Specifies a unique string representing the type of object that is holding the reference.
backLinkKey: Purpose: (Optional) Specifies a string uniquely identifying object that is holding the reference, within the scope of the backLinkType.

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