3.1.4.23.2.2 GetListItemChangesWithKnowledgeResponse

Article
05/16/2023

The GetListItemChangesWithKnowledgeResponse element contains the protocol server response for the GetListItemChangesWithKnowledge request (section 3.1.4.23).

 <s:element name="GetListItemChangesWithKnowledgeResponse">
   <s:complexType>
     <s:sequence>
       <s:element minOccurs="0" maxOccurs="1" name="GetListItemChangesWithKnowledgeResult">
         <s:complexType mixed="true">
           <s:sequence>
             <s:element name="listitems" >
               <s:complexType>
                 <s:sequence>
                   <s:element name="Changes" >
                     <s:complexType>
                       <s:sequence>
                         <s:element name="MadeWithKnowledge" minOccurs="0" maxOccurs="1">
                           <s:complexType>
                             <s:sequence>
                               <s:element ref="sync:syncKnowledge" />
                             </s:sequence>
                           </s:complexType>
                         </s:element>
                         <s:element name="Id" type="tns:ListItemChangeDefinition" minOccurs="0"/>
                         <s:element name="View" type="tns:ViewChangeDefinition" minOccurs="0"/>
                       </s:sequence>
                       <s:attribute name="SchemaChanged" type="core:TRUEFALSE" />
                       <s:attribute name="ServerTime" type="s:string" />
                       <s:attribute name="MoreChanges" type="core:TRUEFALSE" />
                       
                     </s:complexType>
                   </s:element>
                   <s:any />
                 </s:sequence>
                 <s:attribute name="MinTimeBetweenSyncs" type="s:unsignedInt" />
                 <s:attribute name="RecommendedTimeBetweenSyncs" type="s:unsignedInt" />
                 <s:attribute name="MaxBulkDocumentSyncSize" type="s:unsignedInt" />
                 <s:attribute name="MaxRecommendedEmbeddedFileSize" type="s:unsignedInt" />
                 <s:attribute name="AlternateUrls" type="s:string" />
                 <s:attribute name="EffectivePermMask" type="s:string" />
               </s:complexType>
             </s:element>
           </s:sequence>
         </s:complexType>
       </s:element>
     </s:sequence>
   </s:complexType>
 </s:element>

GetListItemChangesWithKnowledgeResult:

The top-level element, which contains a listitems element. listitems includes attributes describing the namespaces for the ADO 2.6 Persistence format, which can be ignored by the protocol client, as well as the Changes element. The following attributes are specified for Changes.

Attribute	Definition
MoreChanges	The Changes element in the response MUST include the attribute MoreChanges set to "TRUE", if more changes are known to the protocol server than were returned to the protocol client. When the protocol client finds MoreChanges set to "TRUE", the protocol client can make another call to GetListItemChangesWithKnowledge by using the new knowledge value of MadeWithKnowledge to retrieve subsequent changes. MoreChanges MUST be included in the result only if the knowledge parameter was specified by the protocol client in the request.
SchemaChanged	The SchemaChanged attribute MUST be set to "TRUE" if there have been schema changes made to the list.
ServerTime	The ServerTime attribute specifies the UTC date and time in the Gregorian calendar when the changes were returned by the server in the format "yyyyMMdd hh:mm:ss": where "yyyy" represents the year, "MM" represents the month, "dd" represents the day of the month, "hh" represents the hour, "mm" represents the minute, and "ss" represents the second. This attribute MUST NOT be set if no changes are returned.

The inner XML of the MadeWithKnowledge element in the Changes element is the knowledge in XML format, as specified in [MS-XSSK] section 3, which represents the last change in the list that is returned to the client. See notes in the knowledge parameter description for more information about paging of data with knowledge.

The ID element in the Changes element represents the change to a list item, as specified in section 2.2.4.13.

The names of the attributes containing the list item data in inner z:row elements correspond to the Name attribute in the Field elements of GetList operation (section 3.1.4.15), and are prefixed by "ows_". Note that the set of fields returned by the method is restricted by the viewField or viewName parameter. If the protocol client requests the MetaInfo field for the list items, the protocol server MUST return the vti_contentchangeunit MetaInfo property, if the property was set in the item or document and the list item or document has not been updated since the time the property was set by a client.

The following attributes are specified for listitems.

Attribute	Definition
MinTimeBetweenSyncs	See the description of the MinTimeBetweenSyncs attribute in GetListItemChangesSinceTokenResponse (section 3.1.4.22.2.2).
RecommendedTimeBetweenSyncs	See the description of the RecommendedTimeBetweenSyncs attribute in GetListItemChangesSinceTokenResponse.
MaxBulkDocumentSyncSize	See the description of the MaxBulkDocumentSyncSize attribute in GetListItemChangesSinceTokenResponse.
MaxRecommendedEmbeddedFileSize	Client applications that are capable of both embedding a document inside another document or linking between documents, and capable of using a server-defined value to control this behavior MUST NOT embed documents larger than this value in other documents. The default is 500 megabytes.<73>
AlternateUrls	See the description of the AlternateUrls attribute in GetListItemChangesSinceTokenResponse.
EffectivePermMask	See the description of the EffectivePermMask attribute in GetListItemChangesSinceTokenResponse.

The listitems element also contains an inner element named rs:data, which is of type DataDefinition (section 2.2.4.7).

The following is an example response from a GetListItemChangesWithKnowledge request:

 <?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Body><GetListItemChangesWithKnowledgeResponse xmlns="http://schemas.microsoft.com/sharepoint/soap/"><GetListItemChangesWithKnowledgeResult><listitems MinTimeBetweenSyncs='0' RecommendedTimeBetweenSyncs='180' MaxBulkDocumentSyncSize='500' AlternateUrls='http://siteaddress/' EffectivePermMask='FullMask' xmlns:s='uuid:BDC6E3F0-6DA3-11d1-A2A3-00AA00C14882'
      xmlns:dt='uuid:C2F41010-65B3-11d1-A29F-00AA00C14882'
      xmlns:rs='urn:schemas-microsoft-com:rowset'
      xmlns:z='#RowsetSchema'>
 <Changes><MadeWithKnowledge><sync:syncKnowledge xmlns="http://schemas.microsoft.com/2008/03/sync/" xmlns:sync="http://schemas.microsoft.com/2008/03/sync/"><idFormatGroup><replicaIdFormat sync:isVariable="false" sync:maxLength="16" /><itemIdFormat sync:isVariable="false" sync:maxLength="16" /><changeUnitIdFormat sync:isVariable="false" sync:maxLength="1" /></idFormatGroup><replicaKeyMap><replicaKeyMapEntry sync:replicaId="udKODRe/Rtu784eyc03pnQ==" sync:replicaKey="0" /></replicaKeyMap><clockVector><clockVectorElement sync:replicaKey="0" sync:tickCount="341" /></clockVector></sync:syncKnowledge></MadeWithKnowledge></Changes>
 <rs:data ItemCount="1">
    <z:row ows_ID='1' ows_Title='Test new entry' ows_MetaInfo='1;#' ows__ModerationStatus='0' ows__Level='1' ows_owshiddenversion='3' ows_UniqueId='1;#{078CAB5C-5FEA-43EA-B23A-FB93EF35397D}' ows_FSObjType='1;#0' ows_Created='2008-01-28 08:06:11' ows_FileRef='1;#Lists/TestListItem/1_.000' />

3.1.4.23.2.2 GetListItemChangesWithKnowledgeResponse

Additional resources