Share via


SharePoint Provider::GetWeb

The GetWebCollection method returns site and list metadata, as well as information about the users and site groups for the current SharePoint site.

Arguments

Input Arguments Required Description

<target>

Yes

The Windows SharePoint Services site to query.

Output Arguments Description

True

If the method succeeds.

Remarks

No remarks.

Sample Code

Comments

Info in the format shown below.

Example XML Request

<request> 
    <procedure> 
 
        <execute namespace="WSS Provider" procedure="GetWeb" 
 
                   impersonate="1"> 
 
            <executeData> 
 
                <target>https://raven003</target> 
 
            </executeData> 
 
        </execute> 
 
    </procedure> 
 
</request> 

Example XML Response

<executeData> 
    <target>https://raven003</target> 
 
    <web> 
 
        <metaData allowAnonymousAccess="0" anonymousViewListItems="1"  
 
            author="AdminRoyS" categoryBucketID="" 
 
            categoryId="" categoryIdPath="" categoryName="" description=""  
 
            externalSecurity="0" inheritedSecurity="0" 
 
            isBucketWeb="0" language="1033" lastModified="2004-05-25 13:25:35Z"  
 
            lastModifiedForceRecrawl="0001-01-01 08:00:00Z" 
 
            noIndex="" title="Team Web Site" usedInAutocat="0"  
 
            validSecurityInfo="1" webID="{D574EA1A-EAD1-4B65-BF57-F6E0BE38A468}"> 
 
            <Permissions> 
 
                <Permission MemberID="1073741829" Mask="-1" MemberIsUser="False"  
 
                    MemberGlobal="False" RoleName="Administrator" /> 
 
                <Permission MemberID="1073741828" Mask="1029638927" MemberIsUser="False"  
 
                    MemberGlobal="False" RoleName="Web Designer" /> 
 
                <Permission MemberID="1073741827" Mask="1027801615" MemberIsUser="False"  
 
                    MemberGlobal="False" RoleName="Contributor" /> 
 
                <Permission MemberID="1073741826" Mask="138608641" MemberIsUser="False"  
 
                    MemberGlobal="False" oleName="Reader" /> 
 
                <Permission MemberID="1073741825" Mask="134283264" MemberIsUser="False"  
 
                    MemberGlobal="False" RoleName="Guest" /> 
 
            </Permissions> 
 
        </metaData> 
 
        <WebsWithTime> 
 
            <WebWithTime timeZ="2004-05-25 13:25:35Z" URL="https://raven003/TestSubSite" /> 
 
        </WebsWithTime> 
 
        <ListsWithTime> 
 
            <ListWithTime timeZ="2004-04-22 02:14:35Z" isEmpty="0"  
 
                internalName="{1055AA38-AC5B-42FD-99E5-58AD8D96F823}" /> 
 
            <ListWithTime timeZ="2004-04-22 02:14:36Z" isEmpty="1"  
 
                internalName="{985EDB87-80D0-463E-B82C-C79C8248A532}" /> 
 
        </ListsWithTime> 
 
        <Roles> 
 
            <Role ID="1073741825" Name="Guest"  
 
                Description="Can view specific lists or document..." 
 
                Type="1"> 
 
                <Users /> 
 
                <Groups /> 
 
            </Role> 
 
            <Role ID="1073741826" Name="Reader"  
 
                Description="Has read-only access to the Web site." 
 
                Type="2"> 
 
                <Users /> 
 
                <Groups /> 
 
            </Role> 
 
            <Role ID="1073741829" Name="Administrator"  
 
                Description="Has full control of the Web site." 
 
                Type="5"> 
 
                <Users> 
 
                    <User ID="1" Sid="S-1-5-21-1177238915-507921405-1343024091-1109"  
 
                        Name="AdminRoyS"  
 
                        LoginName="RAVEN00\adminroys" 
 
                        Email="adminroys@raven00.com" Notes="" IsSiteAdmin="True"  
 
                        IsDomainGroup="False" /> 
 
                </Users> 
 
                <Groups /> 
 
            </Role> 
 
        </Roles> 
 
    </web> 
 
</executeData> 

Typical C# Usage

No typical C# usage.

Applies To

Windows SharePoint Services Provider API for

  • Hosted Messaging and Collaboration version 3.5

  • Hosted Messaging and Collaboration version 3.0

  • Windows-based Hosting version 4.5

  • Windows-based Hosting version 4.0

  • Windows-based Hosting version 3.5

  • Windows-based Hosting for Applications version 1.0

See also

Tasks

SharePoint Provider::GetSiteAndWeb