SharePoint2007Provider::GetListTemplates

  • Article

This procedure of the Webs service returns the collection of list template definitions (including name, displayName, type, baseType, onQuickLaunch, description, image) for the current site.

Arguments

Input Arguments Required Description

<target>

Yes

The URL of the Windows SharePoint Services administration site.

<siteGUID>

Yes

The globally unique identifier (GUID) of the Windows SharePoint Services site collection.

<subSiteGUID>

Yes

The GUID of subsite.
Output Arguments Description

<listTemplate/@name>

The internal name used for the list definition or list template.

<listTemplate/@displayName>

The display name for the list definition or list template.

<listTemplate/@type>

The type of the list definition or list template.

<listTemplate/@baseType>

The base type for the list definition or list template.

<listTemplate/@onQuickLaunch>

A Boolean value that specifies whether any list created with the list definition or list template is displayed on the Quick Launch bar.

<listTemplate/@description>

The description of the list definition or list template that is displayed in the user interface

<listTemplate/@image>

The relative path, based on the server, for the image used to represent the list definition or list template

Remarks

This procedure does not need rollback.

Sample Code

Example XML Request

<request> 
  <data> 
    <target>https://spserver:8181</target> 
    <siteGUID>3F2504E0-4F89-11D3-9A0C-0305E82C3301</userDN> 
    <subSiteGUID>3F2504E0-4F89-11D3-9A0C-0305E82C4284</subSiteGUID> 
  </data> 
  <procedure> 
    <execute namespace="Sharepoint2007Provider" procedure="GetListTemplates" impersonate="1" > 
      <before source="data" destination="executeData" mode="merge"/> 
      <after source="executeData" destination="data" mode="merge"/> 
    </execute> 
  </procedure> 
</request>

Example XML Response

<response> 
  <data> 
    <listTemplates> 
      <listTemplate name="doclib" displayName="Document Library" type="DocumentLibrary"  
                    baseType="DocumentLibrary" onQuickLaunch="true"  
                    description="Create a document library when you have a collection of documents or other files that you want to share.  
                               Document libraries support features such as folders, versioning, and check out."  
                    image="/_layouts/images/itdl.gif" /> 
      <listTemplate name="xmlform" displayName="Form Library" type="XMLForm"  
                    baseType="DocumentLibrary" onQuickLaunch="true"  
                    description="Create a form library when you have XML-based business forms, such as status reports or purchase orders,  
                               that you want to manage. These libraries require a Windows SharePoint Services-compatible XML editor, such as Microsoft Office InfoPath."  
                    image="/_layouts/images/itdl.gif" /> 
    </listTemplates> 
  </data> 
</response>

Applies To

SharePoint 2007 Provider for:

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0