3.3.4.98 GetReservations

The GetReservations operation is used to retrieve the reservation objects corresponding to given reservation IDs.

 <wsdl:operation name="GetReservations" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
   <wsdl:input wsaw:Action="http://Microsoft.Windows.Ipam/IIpamServer/GetReservations" message="ipam:IIpamServer_GetReservations_InputMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl" />
   <wsdl:output wsaw:Action="http://Microsoft.Windows.Ipam/IIpamServer/GetReservationsResponse" message="ipam:IIpamServer_GetReservations_OutputMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl" />
 </wsdl:operation>

Upon receiving the IIpamServer_GetReservations_InputMessage request message, the server performs the following processing steps. Upon successful completion of these steps, the server MUST respond with the IIpamServer_GetReservations_OutputMessage message. In the event of a failure, an appropriate SOAP fault MUST be sent to the client as specified in section 2.2.2.1:

  1. If either of the following conditions is  not satisfied, an appropriate SOAP fault MUST be generated.

    • GetReservations.reservationRecordIds is NULL.

    • GetReservations.addressFamily is neither InterNetwork nor InterNetworkV6.

  2. For each of the reservationId in GetReservations.reservationRecordIds, call the GetDhcpReservation procedure for ADM_DHCPReservationTable with the following parameters:

    1. GetReservations.addressFamily as Param_addressfamily.

    2. reservationId as Param_reservationId.

  3. Add the Result_reservation to GetReservationsResponse.GetReservationsResult.