3.1.4.24 GetListItems

  • Article

The GetListItems operation is used to retrieve details about list items in a list that satisfy specified criteria.

 <wsdl:operation name="GetListItems">
     <wsdl:input message="GetListItemsSoapIn" />
     <wsdl:output message="GetListItemsSoapOut" />
 </wsdl:operation>

The protocol client sends a GetListItemsSoapIn request message (section 3.1.4.24.1.1) and the protocol server responds with a GetListItemsSoapOut response message (section 3.1.4.24.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 is not empty and does not correspond to a list from either of these checks, the protocol server SHOULD<74> return a SOAP fault with error code 0x82000006. This indicates that the list does not exist or could have been deleted by another user.

  4. If listName and viewName are both empty, the protocol server SHOULD<75> return a SOAP fault with error code 0x82000006. This indicates that the list does not exist or might have been deleted by another user.

  5. If the viewName parameter is not a GUID, the protocol server MUST return a SOAP fault with error code 0x82000001. This indicates that the viewName parameter is missing or invalid. If the viewName parameter does not correspond to a view that exists and each of the optional query, viewFields, queryOptions, and rowLimit parameters are not specified, the protocol server MUST return a SOAP fault with error code 0x82000005. Otherwise, if each of the query, viewFields, queryOptions, and rowLimit parameters are specified, the protocol server MUST ignore the viewName parameter.

  6. Otherwise, all list items in the list matching the specified criteria MUST be returned, unless the protocol server encounters an unexpected situation and MUST return a SOAP fault. There is no specific error code for this fault.