Renew

The Enumeration Endpoint implements the Renew operation, which renews the specified Enumeration context. This revises the expiration time of the Enumeration request.

Parameters

Action Header

For more information, see WS-Enumeration specification.

EnumerationContext Element

According to the WS-Enumeration specification, an invocation of the Renew operation uses as input whatever was provided as the enumeration context in the response to the corresponding invocation of the Enumerate operation.

Return Value

Action Header

For more information, see WS-Enumeration specification.

Expires Element

Responses to successful invocations of the Renew operation will incorporate the <Expires> element defined in the WS-Enumeration specification. This element gives the expiration time of the enumeration context. The expiration time is always calculated so that the enumeration context does not expire.

Example

The following code example shows an invocation of the Renew operation.

<s:Envelope 
  xmlns:s='http://www.w3.org/2003/05/soap-envelope' 
  xmlns:wsa='https://schemas.xmlsoap.org/ws/2004/08/addressing' 
  xmlns:wsen='https://schemas.xmlsoap.org/ws/2004/09/enumeration'
  xmlns:wsc='https://schemas.microsoft.com/ws/2006/05/context'
  xmlns:rm='https://schemas.microsoft.com/2006/11/ResourceManagement'>
  <s:Header>
    <wsa:ReplyTo>
     <wsa:Address> 
       https://www.contoso.com/sender
     </wsa:Address>
    </wsa:ReplyTo>
    <wsa:To> 
      https://www.contoso.com:5725/IdentityManagementService/Enumeration
    </wsa:To>
    <wsa:Action>
      https://schemas.xmlsoap.org/ws/2004/09/enumeration/Renew
    </wsa:Action>
    <wsa:MessageID>
      uuid:00000000-0000-0000-C000-000000000046
    </wsa:MessageID>
    <rm:ResourceManagement s:mustUnderstand=“true"/>
  </s:Header>
  <s:Body>
    <wsen:Renew>
      <wsen:EnumerationContext>     
        <rm:Count>1</rm:Count> 
        <rm:CurrentIndex>0</rm:CurrentIndex> 
      <rm:EnumerationDirection>Forwards</rm:EnumerationDirection> 
        <rm:Expires>12/31/9999 11:59:59 PM</rm:Expires> 
        <rm:Filter>/ma-data</rm:Filter> 
        <rm:LocalePreferences xsi:nil="true" /> 
        <rm:Selection xsi:nil="true" /> 
        <rm:Sorting xsi:nil="true" /> 
      </wsen:EnumerationContext>
      <wsen:Expires>
       12/31/9999 11:59:59 PM
      </wsen:Expires>
    </wsen:Renew>
  </s:Body>
</s:Envelope>

The following code example shows a response to a successful invocation of the Renew operation.

<s:Envelope 
  xmlns:s='http://www.w3.org/2003/05/soap-envelope' 
  xmlns:wsa='https://schemas.xmlsoap.org/ws/2004/08/addressing' 
  xmlns:wsen='https://schemas.xmlsoap.org/ws/2004/09/enumeration' 
  xmlns:wsc='https://schemas.microsoft.com/ws/2006/05/context'
  xmlns:rm='https://schemas.microsoft.com/2006/11/ResourceManagement' >
  <s:Header>
    <wsa:To>
      https://www.contoso.com/sender
    </wsa:To>
    <wsa:Action>      
      https://schemas.xmlsoap.org/ws/2004/09/enumeration/RenewResponse
    </wsa:Action>
    <wsa:MessageID>
      uuid:0000010e-0000-0000-C000-000000000048
    </wsa:MessageID>
    <wsa:RelatesTo>
      uuid:00000000-0000-0000-C000-000000000048
    </wsa:RelatesTo>
  </s:Header>
  <s:Body>
    <wsen:RenewResponse>
      <wsen:Expires>
        12/31/9999 11:59:59 PM
      </wsen:Expires>
    </wsen:RenewResponse>
  </s:Body>
</s:Envelope>

See Also

Concepts

Enumeration Endpoint
Web Services Overview
Resource Factory Endpoint