SiteData Web Service

SiteData

Click here for a complete list of operations.

GetWeb

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /_vti_bin/SiteData.asmx HTTP/1.1
Host: newfarmss.eq.edu.au
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://schemas.microsoft.com/sharepoint/soap/GetWeb"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetWeb xmlns="http://schemas.microsoft.com/sharepoint/soap/" />
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetWebResponse xmlns="http://schemas.microsoft.com/sharepoint/soap/">
      <GetWebResult>unsignedInt</GetWebResult>
      <sWebMetadata>
        <WebID>string</WebID>
        <Title>string</Title>
        <Description>string</Description>
        <Author>string</Author>
        <Language>unsignedInt</Language>
        <LastModified>dateTime</LastModified>
        <LastModifiedForceRecrawl>dateTime</LastModifiedForceRecrawl>
        <NoIndex>string</NoIndex>
        <ValidSecurityInfo>boolean</ValidSecurityInfo>
        <InheritedSecurity>boolean</InheritedSecurity>
        <AllowAnonymousAccess>boolean</AllowAnonymousAccess>
        <AnonymousViewListItems>boolean</AnonymousViewListItems>
        <Permissions>string</Permissions>
        <ExternalSecurity>boolean</ExternalSecurity>
        <CategoryId>string</CategoryId>
        <CategoryName>string</CategoryName>
        <CategoryIdPath>string</CategoryIdPath>
        <IsBucketWeb>boolean</IsBucketWeb>
        <UsedInAutocat>boolean</UsedInAutocat>
        <CategoryBucketID>string</CategoryBucketID>
      </sWebMetadata>
      <vWebs>
        <_sWebWithTime>
          <Url>string</Url>
          <LastModified>dateTime</LastModified>
        </_sWebWithTime>
        <_sWebWithTime>
          <Url>string</Url>
          <LastModified>dateTime</LastModified>
        </_sWebWithTime>
      </vWebs>
      <vLists>
        <_sListWithTime>
          <InternalName>string</InternalName>
          <LastModified>dateTime</LastModified>
          <IsEmpty>boolean</IsEmpty>
        </_sListWithTime>
        <_sListWithTime>
          <InternalName>string</InternalName>
          <LastModified>dateTime</LastModified>
          <IsEmpty>boolean</IsEmpty>
        </_sListWithTime>
      </vLists>
      <vFPUrls>
        <_sFPUrl>
          <Url>string</Url>
          <LastModified>dateTime</LastModified>
          <IsFolder>boolean</IsFolder>
        </_sFPUrl>
        <_sFPUrl>
          <Url>string</Url>
          <LastModified>dateTime</LastModified>
          <IsFolder>boolean</IsFolder>
        </_sFPUrl>
      </vFPUrls>
      <strRoles>string</strRoles>
      <vRolesUsers>
        <string>string</string>
        <string>string</string>
      </vRolesUsers>
      <vRolesGroups>
        <string>string</string>
        <string>string</string>
      </vRolesGroups>
    </GetWebResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /_vti_bin/SiteData.asmx HTTP/1.1
Host: newfarmss.eq.edu.au
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetWeb xmlns="http://schemas.microsoft.com/sharepoint/soap/" />
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetWebResponse xmlns="http://schemas.microsoft.com/sharepoint/soap/">
      <GetWebResult>unsignedInt</GetWebResult>
      <sWebMetadata>
        <WebID>string</WebID>
        <Title>string</Title>
        <Description>string</Description>
        <Author>string</Author>
        <Language>unsignedInt</Language>
        <LastModified>dateTime</LastModified>
        <LastModifiedForceRecrawl>dateTime</LastModifiedForceRecrawl>
        <NoIndex>string</NoIndex>
        <ValidSecurityInfo>boolean</ValidSecurityInfo>
        <InheritedSecurity>boolean</InheritedSecurity>
        <AllowAnonymousAccess>boolean</AllowAnonymousAccess>
        <AnonymousViewListItems>boolean</AnonymousViewListItems>
        <Permissions>string</Permissions>
        <ExternalSecurity>boolean</ExternalSecurity>
        <CategoryId>string</CategoryId>
        <CategoryName>string</CategoryName>
        <CategoryIdPath>string</CategoryIdPath>
        <IsBucketWeb>boolean</IsBucketWeb>
        <UsedInAutocat>boolean</UsedInAutocat>
        <CategoryBucketID>string</CategoryBucketID>
      </sWebMetadata>
      <vWebs>
        <_sWebWithTime>
          <Url>string</Url>
          <LastModified>dateTime</LastModified>
        </_sWebWithTime>
        <_sWebWithTime>
          <Url>string</Url>
          <LastModified>dateTime</LastModified>
        </_sWebWithTime>
      </vWebs>
      <vLists>
        <_sListWithTime>
          <InternalName>string</InternalName>
          <LastModified>dateTime</LastModified>
          <IsEmpty>boolean</IsEmpty>
        </_sListWithTime>
        <_sListWithTime>
          <InternalName>string</InternalName>
          <LastModified>dateTime</LastModified>
          <IsEmpty>boolean</IsEmpty>
        </_sListWithTime>
      </vLists>
      <vFPUrls>
        <_sFPUrl>
          <Url>string</Url>
          <LastModified>dateTime</LastModified>
          <IsFolder>boolean</IsFolder>
        </_sFPUrl>
        <_sFPUrl>
          <Url>string</Url>
          <LastModified>dateTime</LastModified>
          <IsFolder>boolean</IsFolder>
        </_sFPUrl>
      </vFPUrls>
      <strRoles>string</strRoles>
      <vRolesUsers>
        <string>string</string>
        <string>string</string>
      </vRolesUsers>
      <vRolesGroups>
        <string>string</string>
        <string>string</string>
      </vRolesGroups>
    </GetWebResponse>
  </soap12:Body>
</soap12:Envelope>