SiteData.GetChanges Method

Returns the changes that occurred on a site collection content from one moment in time to another.

Namespace:  [SiteData Web service]
Web service reference: http://Site/_vti_bin/SiteData.asmx

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/GetChanges", RequestNamespace := "https://schemas.microsoft.com/sharepoint/soap/",  _
    ResponseNamespace := "https://schemas.microsoft.com/sharepoint/soap/",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Function GetChanges ( _
    objectType As ObjectType, _
    contentDatabaseId As String, _
    ByRef startChangeId As String, _
    ByRef endChangeId As String, _
    Timeout As Integer, _
    <OutAttribute> ByRef moreChanges As Boolean _
) As String
'Usage
Dim instance As SiteData
Dim objectType As ObjectType
Dim contentDatabaseId As String
Dim startChangeId As String
Dim endChangeId As String
Dim Timeout As Integer
Dim moreChanges As Boolean
Dim returnValue As String

returnValue = instance.GetChanges(objectType, _
    contentDatabaseId, startChangeId, _
    endChangeId, Timeout, moreChanges)

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/GetChanges", RequestNamespace = "https://schemas.microsoft.com/sharepoint/soap/", 
    ResponseNamespace = "https://schemas.microsoft.com/sharepoint/soap/", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public string GetChanges(
    ObjectType objectType,
    string contentDatabaseId,
    ref string startChangeId,
    ref string endChangeId,
    int Timeout,
    out bool moreChanges
)

Parameters

• objectType
  Type: [SiteData Web service].ObjectType

  The change tracking space to report about, either "ContentDatabase" or "Site". All other objectType values, as defined in ObjectType should not be used. The server may treat all other types as "Site". Note that "Site" in the context of this parameter actually means site collection.

• contentDatabaseId
  Type: System.String

  GUID of the content database, known in advance or obtained by GetContent request.

• startChangeId
  Type: System.String

• endChangeId
  Type: System.String

• Timeout
  Type: System.Int32

  Timeout, in seconds, which the client gives the server to collect changes. The server MUST NOT spend more than this amount of time preparing the response.

• moreChanges
  Type: System.Boolean

  Indicates whether the server is aware of any more changes before the one marked by CurrentChangeId token. If the server has successfully collected all change records for the requested increment within the Timeout limit, then the server MUST specify moreChanges = false. Also in this case the server MUST set LastChangeId and CurrentChangeId to the same value. This tells the client that there are no more changes marked before the CurrentChangeId token.

  If the server was unable to collect all change records within the Timeout or other constraints, the server MUST specify moreChanges = true. This tells the client that it SHOULD repeat the request using the suggested LastChangeId and CurrentChangeId.

  If the server is unable to collect all change records because the client passed a LastChangeId token that is older than the server's change records, then the sever MUST return the following SOAP error in response to the GetChanges operation:

Return Value

Type: System.String

Remarks

The GetChanges operation is used by the client to request the changes that occurred on a site from one moment in time up to another moment in time. These moments in time are specified by opaque ChangeId tokens. ChangeId tokens are created and used by the server to serialize the records of all atomic changes.

Operations GetContent and GetChanges are used for full and then incremental content indexing.

The user or principal that performs GetContent and GetChanges operations must have a special permission, called Full Read.

Full Read permission is not normally granted to any user, not even to Administrators. By default, only the service account used by the built-in indexing agent is granted Full Read permission.

See Also

Reference

SiteData Class

SiteData Members

SiteData Web Service