GetStatus

The Enumeration Endpoint implements the GetStatus operation, which retrieves the expiration time for the specified Enumeration context.

Parameters

Action Header

For more information, see WS-Enumeration specification.

Enumeration Context Element

According to the WS-Enumeration specification, an invocation of the GetStatus 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 GetStatus 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 such that the enumeration context does not expire.

Example

The following is an example invocation of the GetStatus 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/GetStatus
    </wsa:Action>
    <wsa:MessageID>
      uuid:00000000-0000-0000-C000-000000000046
    </wsa:MessageID>
    <rm:ResourceManagement s:mustUnderstand=“true"/>
  </s:Header>
  <s:Body>
    <wsen:GetStatus>
      <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:GetStatus>
  </s:Body>
</s:Envelope>

The following is an example response to a successful invocation of the GetStatus 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/GetStatusResponse
    </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:GetStatusResponse>
      <wsen:Expires>
        12/31/9999 11:59:59 PM
      </wsen:Expires>
    </wsen:GetStatusResponse>
  </s:Body>
</s:Envelope>

See Also

Concepts

Enumeration Endpoint
Web Services Overview
Resource Factory Endpoint