3.1.4.22 GetListItemChangesSinceToken

  • Article

The GetListItemChangesSinceToken operation<65> is used to return changes made to a specified list after the event expressed by the change token, if specified, or to return all the list items in the list.

 <wsdl:operation name="GetListItemChangesSinceToken">
     <wsdl:input message="GetListItemChangesSinceTokenSoapIn" />
     <wsdl:output message="GetListItemChangesSinceTokenSoapOut" />
 </wsdl:operation>

The protocol client sends a GetListItemChangesSinceTokenSoapIn request message (section 3.1.4.22.1.1) and the protocol server responds with a GetListItemChangesSinceTokenSoapOut response message (section 3.1.4.22.1.2), as follows:

  1. If the specified listName is a valid GUID and corresponds to the identification of a list on the site, use that list.

  2. If the specified listName is not a valid GUID or does not correspond to the identification of a list on the site, check if the listName corresponds to the list title of a list on the site and if so, use that list.

  3. If the specified listName does not correspond to a list from either of these checks, the protocol server SHOULD<66> return a SOAP fault with error code 0x82000006. This indicates that the list does not exist or might have been deleted by another user.

  4. If the viewFields parameter is not specified and the viewName parameter contains a valid GUID but refers to a view that does not exist, the protocol server MUST return a SOAP fault. If the viewFields parameter is not specified and the viewName parameter contains an invalid GUID, the server SHOULD<67> ignore the viewName parameter. Otherwise, if the viewFields parameter is specified, the server MUST ignore the viewName parameter.

  5. If the value of the changeToken parameter is empty, the protocol server SHOULD ignore the changeToken parameter<68>. If the value of the changeToken parameter is not empty and does not match a change token known to the protocol server, the protocol server MUST return a SOAP fault. There is no error code for this fault.

  6. Otherwise, all list items specified by the listName parameter that match the criteria passed in MUST be returned, unless the protocol server encounters an unexpected situation and MUST return a SOAP fault.