GetListContentTypes

GetListContentTypeResult: The container for the returned content type data.

ContentType: The node containing data for the content type. See [MS-WSSCAML] section 2.4.

3.1.4.19 GetListContentTypes

The GetListContentTypes operation<50> is used to retrieve all content types from a list.

<wsdl:operation name="GetListContentTypes">

<wsdl:input message="GetListContentTypesSoapIn" />

<wsdl:output message="GetListContentTypesSoapOut" />

</wsdl:operation>

The protocol client sends a GetListContentTypesSoapIn message (section 3.1.4.19.1.1) and the protocol server responds with a GetListContentTypesSoapOut message (section 3.1.4.19.1.2).

3.1.4.19.1 Messages

The following table summarizes the set of WSDL message definitions that are specific to this operation.

Message Description

GetListContentTypesSoapIn The request to retrieve all content types from a list.

GetListContentTypesSoapOut The response to a request to retrieve all content types from a list.

3.1.4.19.1.1 GetListContentTypesSoapIn

The GetListContentTypesSoapIn message is the request to return all content types on a list.

The SOAP action value of the message is defined as follows:

http://schemas.microsoft.com/sharepoint/soap/GetListContentTypes

The SOAP body contains a GetListContentTypes element (section 3.1.4.19.2.1).

3.1.4.19.1.2 GetListContentTypesSoapOut

The GetListContentTypesSoapOut message is the response to the request to return all content types on a list.

The SOAP action value of the message is defined as follows:

http://schemas.microsoft.com/sharepoint/soap/GetListContentTypes

The SOAP body contains a GetListContentTypesResponse element (section 3.1.4.19.2.2).

3.1.4.19.2 Elements

The following table summarizes the XML schema element definitions that are specific to this operation.

Element Description

GetListContentTypes The request to retrieve all content types from a list.

GetListContentTypesResponse Contains the response to a request to retrieve all content types from a list.

3.1.4.19.2.1 GetListContentTypes

The GetListContentTypes element specifies the details of the request to return all content types on a list.

<s:element name="GetListContentTypes">

<s:complexType>

<s:sequence>

<s:element minOccurs="0" maxOccurs="1" name="listName" type="s:string" />

<s:element name="contentTypeId" type="core:ContentTypeId" minOccurs="0"/>

</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, as follows:

 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 SHOULD<51> 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 GetListContentTypesResponse element (section 3.1.4.19.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 GetListContentTypesResponse element.

3.1.4.19.2.2 GetListContentTypesResponse

The GetListContentTypesResponse element is the response that contains all content types on a list.

<s:element name="GetListContentTypesResponse">

<s:complexType>

<s:sequence>

<s:element name="GetListContentTypesResult" minOccurs="0">

<s:complexType mixed="true">

GetListContentTypesResult: The container element for the results.

GetListContentTypesResult.ContentTypes: The container element for the content types.

GetListContentTypesResult.ContentTypes.ContentTypeOrder: A string of content type identifiers delimited by commas. This specifies the order in which the content types are displayed to the user when the user tries to create a new item in this list. This MUST NOT be returned if the list is a user information list.<52>

GetListContentTypesResult.ContentTypes.ContentType: The container element for a single content type, as specified in [MS-WSSCAML] section 2.4.

GetListContentTypesResult.ContentTypes.ContentType.XmlDocuments: A collection of XML documents associated with this content type, which can include forms and event receiver manifests.

The XmlDocumentDefinitionCollection type is specified in [MS-WSSCAML] section 2.4.12.

GetListContentTypesResult.ContentTypes.ContentType.Name: The name of the content type.

GetListContentTypesResult.ContentTypes.ContentType.ID: The content type identifier for this content type.

GetListContentTypesResult.ContentTypes.ContentType.Description: The description of the content type.

GetListContentTypesResult.ContentTypes.ContentType.Scope: The fully qualified URL to the content type scope.

GetListContentTypesResult.ContentTypes.ContentType.Version: Specifies the current version of the content type. The protocol server MUST increment the value by one each time the content type definition is edited. The protocol client MUST ignore this attribute.

GetListContentTypesResult.ContentTypes.ContentType.BestMatch: MUST be specified on at most one ContentType element. If specified at all, this element MUST be specified on the

ContentType element that represents the "best match" to the content type identified by the contentTypeId element in the GetListContentTypesSoapIn message (section 3.1.4.19.1.1).