SharePoint2007Provider::GetWeb

This procedure returns site and list metadata, as well as information about the users and site groups for the specified SharePoint 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 Windows SharePoint Services site collection.
<subSiteGUID>	Yes	The GUID of subsite.

Output Arguments	Description
<metadata/@allowAnonymousAccess>	A Boolean value that indicates whether anonymous access is allowed for the Web site.
<metadata/@author>	A user object representing the user who created the Web site.
<metadata/@description>	The description for the site.
<metadata/@language>	The list definition type on which the list is based.
<metadata/@lastModified>	The LCID for the language used on the site.
<metadata/@title>	The title for the Web site.
<metadata/@webId>	The GUID for the site.
<Permission/@memberId>	The collection of role assignments for the list.
<Permission/@ mask>	The collection of role assignments for the list.
<Permission/@ roleName>	The collection of role assignments for the list.
<webWithTime/@timZ>	The date and time value that indicates when the site was created.
<webWithTime/@url>	The absolute URL for the Web site.
<listWithTime/@timZ>	The creation date and time for the list.
<listWithTime/@isEmpty>	A Boolean value that indicates whether the list is empty.
<listWithTime/@internalName>	The GUID that identifies the list in the database.
<Role/@ID>	The ID of the role definition within the collection.
<Role/@Name>	The name of the role definition.
<Role/@Description>	A description for the role definition.
<Role/@Type>	The type of the role definition.
<Role/@Hidden>	A Boolean value that indicates whether the role definition is displayed on the Add Users page.
<Role/@Order>	The order in which permission levels are displayed on the Permission Levels page for a site collection.
<Role/@BasePermissions>	The base permissions for a role definition.
<User/@ID>	The member ID for the user.
<User/@Sid>	The unique security ID for the network account of the user.
<User/@Name>	The display name of the user.
<User/@LoginName>	The user name of the user.
<User/@Email>	The e-mail address of the user.
<User/@Notes>	The notes for the user.
<User/@IsSiteAdmin>	A Boolean value that specifies whether the user is a site collection administrator.
<User/@IsDomainGroup>	A Boolean value that indicates whether the user is a domain group.
<Group/@ID>	The member ID for the group.
<Group/@Name>	The name of the group.
<Group/@Description>	The description for the group.
<Group/@OwnerID>	The member ID for the owner.

Remarks

Sample Code

Example XML Request

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

Example XML Response

<response>
  <data>
	<web>
	<metaData allowAnonymousAccess="false" author="FABRIKAM\administrator" description="Site Created" language="1033" lastModified="8/13/2007 2:22:13 AM" title="Test Site" webId="cb07fe6b-137b-459b-9972-c0d74d2e2b23">
		<permissions>
		<permission memberId="1" mask="-1" roleName="FABRIKAM\administrator" />
		</permissions>
	</metaData>
	<websWithTime />
	<listsWithTime>
		<listWithTime timeZ="8/13/2007 2:22:12 AM" isEmpty="false" internalName="2d4cecb4-7302-4b5c-8af9-9d364ace9eba" />
		<listWithTime timeZ="8/13/2007 2:22:12 AM" isEmpty="true" internalName="d94d5e31-80ab-4bf7-8bad-11ae0b49e172" />
	</listsWithTime>
	<roles>
		<role id="1073741829" name="Full Control" description="Has full control." type="Administrator" order="0" hidden="false" basePermissions="FullMask">
		<users>
			<user id="1" sid="S-1-5-21-3511655109-3096873398-1435752672-500" name="Administrator" loginName="FABRIKAM\administrator" email="Administrator@Fabrikam.Com" notes="" isSiteAdmin="true" isDomainGroup="false" />
		</users>
		<groups />
		</role>
		<role id="1073741828" name="Design" description="Can view, add, update, delete, approve, and customize." type="WebDesigner" order="0" hidden="false" basePermissions="ViewListItems, AddListItems, EditListItems, DeleteListItems, ApproveItems, OpenItems, ViewVersions, DeleteVersions, CancelCheckout, ManagePersonalViews, ManageLists, ViewFormPages, Open, ViewPages, AddAndCustomizePages, ApplyThemeAndBorder, ApplyStyleSheets, CreateSSCSite, BrowseDirectories, BrowseUserInfo, AddDelPrivateWebParts, UpdatePersonalWebParts, UseClientIntegration, UseRemoteAPIs, CreateAlerts, EditMyUserInfo">
		<users>
			<user id="1" sid="S-1-5-21-3511655109-3096873398-1435752672-500" name="Administrator" loginName="FABRIKAM\administrator" email="Administrator@Fabrikam.Com" notes="" isSiteAdmin="true" isDomainGroup="false" />
		</users>
		<groups />
		</role>
		<role id="1073741827" name="Contribute" description="Can view, add, update, and delete." type="Contributor" order="0" hidden="false" basePermissions="ViewListItems, AddListItems, EditListItems, DeleteListItems, OpenItems, ViewVersions, DeleteVersions, ManagePersonalViews, ViewFormPages, Open, ViewPages, CreateSSCSite, BrowseDirectories, BrowseUserInfo, AddDelPrivateWebParts, UpdatePersonalWebParts, UseClientIntegration, UseRemoteAPIs, CreateAlerts, EditMyUserInfo">
		<users>
			<user id="1" sid="S-1-5-21-3511655109-3096873398-1435752672-500" name="Administrator" loginName="FABRIKAM\administrator" email="Administrator@Fabrikam.Com" notes="" isSiteAdmin="true" isDomainGroup="false" />
		</users>
		<groups />
		</role>
		<role id="1073741826" name="Read" description="Can view only." type="Reader" order="0" hidden="false" basePermissions="ViewListItems, OpenItems, ViewVersions, ViewFormPages, Open, ViewPages, CreateSSCSite, BrowseUserInfo, UseClientIntegration, UseRemoteAPIs, CreateAlerts">
		<users>
			<user id="1" sid="S-1-5-21-3511655109-3096873398-1435752672-500" name="Administrator" loginName="FABRIKAM\administrator" email="Administrator@Fabrikam.Com" notes="" isSiteAdmin="true" isDomainGroup="false" />
		</users>
		<groups />
		</role>
		<role id="1073741825" name="Limited Access" description="Can view specific lists, document libraries, list items, folders, or documents when given permissions." type="Guest" order="0" hidden="true" basePermissions="ViewFormPages, Open, BrowseUserInfo, UseClientIntegration, UseRemoteAPIs">
		<users>
			<user id="1" sid="S-1-5-21-3511655109-3096873398-1435752672-500" name="Administrator" loginName="FABRIKAM\administrator" email="Administrator@Fabrikam.Com" notes="" isSiteAdmin="true" isDomainGroup="false" />
		</users>
		<groups />
		</role>
	</roles>
	</web>
  </data>
</response>

Applies To