SharePoint2007Provider::GetList

  • Article

This procedure returns metadata from the specified SharePoint list.

Arguments

Input Arguments Required Description

<target>

Yes

The URL of the Windows SharePoint Services administration site.

<siteGUID>

Yes

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

<subSiteGUID>

Yes

The GUID of sub site.

<list>

Yes

A string that contains either the name of the list or the GUID of the list enclosed in curly braces ({}).
Output Arguments Description

<metadata/@title>

The date and time that an item, field, or property of the list was last modified.

<metadata/@description>

The description for the list.

<metadata/@baseType>

The base type of the list.

<metadata/@baseTemplate>

The list definition type on which the list is based.

<metadata/@defaultViewUrl>

The URL of the default view for the list.

<metadata/@lastModified>

The date and time that an item, field, or property of the list was last modified.

<metadata/@author>

An SPUser object representing information about the user who created the list.

<metadata/@inheritedSecurity>

A Boolean value that specifies whether the collection is inherited from the parent object.

<metadata/@readSecurity>

The Read security setting for the list.

<permissions>

The collection of field objects that represents all the fields in the list, including:

  • <permission/@memberId>

  • <permission/@mask>

  • <permission/@memberIsUser>

  • <permission/@memberGlobal>

<fields>

The collection of role assignments for the list, including:

  • <Field/@name>

  • <Field/@title>

  • <Field/@type>

Remarks

This procedure does not need rollback.

Sample Code

Example XML Request

<request> 
   <procedure> 
      <execute namespace="SharePoint2007Provider" procedure="GetList" impersonate="1"> 
         <executeData> 
            <target>https://WSSFE:8080</target> 
            <siteGUID>9f063208-8d4c-41b7-9312-4faadddc1435</siteGUID> 
            <subSiteGUID>cf60533d-0f36-4a79-8db1-20997cb37ccc</subSiteGUID> 
            <list>Announcements</list> 
         </executeData> 
         <after source="executeData" destination="data" mode="merge" /> 
      </execute> 
   </procedure> 
</request>

Example XML Response

<response> 
   <data> 
      <metaData title="Announcements" description="Use the Announcements list to post messages on the home page of your site." baseType="GenericList" baseTemplate="Announcements" defaultViewUrl="/sites/SPNSSite/Lists/Announcements/AllItems.aspx" lastModified="8/13/2007 2:12:04 AM" author="FABRIKAM\administrator" inheritedSecurity="true" readSecurity="1" /> 
      <permissions> 
         <permission memberId="1" mask="9223372036854775807" memberIsUser="false" memberGlobal="false" /> 
      </permissions> 
      <fields> 
         <field name="ID" title="ID" type="Counter" /> 
         <field name="ContentTypeId" title="Content Type ID" type="ContentTypeId" /> 
         <field name="ContentType" title="Content Type" type="Text" /> 
         <field name="Expires" title="Expires" type="DateTime" /> 
      </fields> 
   </data> 
</response>

Applies To

SharePoint 2007 Provider for:

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0

See also

Tasks

SharePoint2007Provider::GetLists