CheckSubwebAndList Method

Article
03/25/2009

The CheckSubwebAndList method of the Imaging service checks the specified URL and attempts to resolve it.

Parameters

strUrl The URL to be analyzed.

Return Value

A Microsoft.SharePoint.SoapServer.SoapXml object that contains the resolved URL. For example, if thestrUrl parameter is http://dzhang1gs/t1/forms/allitems.aspx, the Microsoft.SharePoint.SoapServer.SoapXml object contains the following:

<result xmlns="http://schemas.microsoft.com/sharepoint/soap/ois/"
  url="http://Server_Name/t1/forms/allitems.aspx"
  subweb="http://Server_Name" list="t1" rest="/forms/allitems.aspx" />

Remarks

The CheckSubwebAndList method will attempt to resolve as much of the URL as it can and leave the remaining part in rest attribute.

Error Values

The following table shows errors that may be returned by the CheckSubwebAndList method.

Error Code	Description
0x1	ListNotFound: The requested list is not found.
0x2	IsNotLibrary: The requested list, although found, is not a picture library.
0x3	ItemNotFound: The requested list item is not found.
0x4	FolderNotFound: The requested folder is not found.
0x5	InvalidArgument: One or more arguments are not valid.
0x6	FileExists: The file already exists, and the user doesn't specify the overwrite option.

SOAP Request Format

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

POST /_vti_bin/imaging.asmx HTTP/1.1
Host: Server_Name
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://schemas.microsoft.com/sharepoint/soap/ois/CheckSubwebAndList"

<?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>
    <CheckSubwebAndList xmlns="http://schemas.microsoft.com/sharepoint/soap/ois/">
      <strUrl>string</strUrl>
    </CheckSubwebAndList>
  </soap:Body>
</soap:Envelope>

SOAP Response Format

The following is a sample SOAP response. The placeholders shown will be replaced with actual values.

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>
    <CheckSubwebAndListResponse xmlns="http://schemas.microsoft.com/sharepoint/soap/ois/">
      <CheckSubwebAndListResult>
        <xsd:schema>schema</xsd:schema>xml</CheckSubwebAndListResult>
    </CheckSubwebAndListResponse>
  </soap:Body>
</soap:Envelope>

Requirements

Platforms: Microsoft Windows Server 2003

Web Reference: http://Server_Name/[sites/][Site_Name/]_vti_bin/Imaging.asmx

Share via