Share via

3.1.4.20.2.1 GetListContentTypesAndProperties

  • Article

The GetListContentTypesAndProperties element specifies the details of the GetListContentTypesAndPropertiesSoapIn request (section 3.1.4.20.1.1).

 <s:element name="GetListContentTypesAndProperties">
   <s:complexType>
     <s:sequence>
         <s:element minOccurs="0" maxOccurs="1" name="listName" type="s:string" />
         <s:element name="contentTypeId" type="core:ContentTypeId" minOccurs="0" maxOccurs="1"/>
         <s:element name="propertyPrefix" type="s:string" minOccurs="0" maxOccurs="1"/>
         <s:element name="includeWebProperties" type="s:boolean" minOccurs="0" maxOccurs="1"/>
     </s:sequence>
   </s:complexType>
 </s:element>
 

listName: The GUID, or title of the list, from which data SHOULD be returned.

contentTypeId: The identifier of a content type for which the client requests that the server find a "best match" among those content types that exist on the list.

propertyPrefix: The prefix of the requested property keys.

includeWebProperties: Specifies the protocol client’s request for properties and files from the property bag of the site that contains the specified list. If the element is True, the protocol server MUST return properties and files from the site property bag. If the element is False, the protocol server MUST NOT return properties and files from the site property bag.

If listName is a valid GUID and corresponds to the identification of a list on the site, the protocol server MUST use that list. If listName is not a valid GUID or does not correspond to the identification of a list on the site, the protocol server MUST check to see if listName corresponds to the title of a list on the site and if so, MUST use that list. If listName does not correspond to a list from either of these checks, the protocol server MUST return a SOAP fault with error code 0x82000006. This indicates that the list does not exist or might have been deleted by another user.

If the contentTypeId parameter is specified, the protocol server MUST attempt to find the "best match" to the specified content type from among those on the list. If the content type specified by contentTypeId exists on the list, the server MUST choose that content type as the best match. Otherwise, the algorithm for determining best match is a server implementation choice. If the server succeeds in finding a best match to the specified content type, the server MUST set the BestMatch attribute of the selected content type to "TRUE" in the GetListContentTypesAndPropertiesResponse element (section 3.1.4.20.2.2). If the server is unable to find a "best match," the server MUST NOT set the BestMatch attribute to "TRUE" for any of the content types returned in the GetListContentTypesAndPropertiesResponse element.

If the propertyPrefix parameter is not empty, the protocol server MUST return all of the properties in the list property bag whose property key begins with the propertyPrefix. The protocol sever MUST also return the contents of all files referenced by a property in the list property bag whose key begins with propertyPrefix and ends with the suffix "_file". If the propertyPrefix parameter is empty, the protocol server MUST return all of the properties in the list property bag, regardless of key, and MUST return the contents of all files referenced by properties in the list property bag whose keys end with the "_file" suffix. If the includeWebProperties parameter is set to "TRUE" the protocol server MUST return properties and files from the site property bag in addition to properties and files from the list property bag. The selection of properties from the site property bag MUST follow the same rules as used for the list property bag (described in the preceding paragraph). If includeWebProperties is "FALSE", the protocol server MUST NOT return any properties or files from the site property bag.