Share via

GetDwsMetaData Method

  • Article

The GetDwsMetaData method of the Document Workspace service returns information about a Document Workspace site and the lists it contains.

Parameters

document  String. The site-based URL of a document in a document library in the Document Workspace site; for example, "Shared Documents/document_name.doc." This argument provides context for the document information returned by the GetDwsMetaData method.

id  String. An optional document globally unique identifier (GUID). The id argument is used by Microsoft Office Outlook 2003 to retrieve the full document URL when a user opens a shared attachment.

minimal  Boolean. Determines whether the output includes information about the schemas, lists, documents, links, and tasks lists of a Document Workspace site.

Return Value

String An XML document fragment that contains the following information:

  • SubscribeUrl
  • MtgInstance (meeting instance, if applicable)
  • SettingsUrl (site settings URL)
  • PermsUrl (edit permissions url)
  • UserInfoUrl (user information url)
  • Roles
  • [Schema items] (if Minimal is False)
  • [ListInfo items] (if Minimal is False)
  • Permissions
  • HasUniquePerm (true/false)
  • WorkspaceType ("DWS", "MWS", "SPS", "")
  • IsADMode (true/false)
  • DocUrl
  • Minimal (true/false)
  • Results (data returned by the GetDwsData method)

Error Values

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

Error Code Description
HTTP error code 401 The user does not have sufficient rights.

Remarks

The GetDwsMetaData method returns more information about a Document Workspace site than the GetDwsData method. When Minimal is False, the GetDwsMetaData method includes additional information about the schemas, lists, documents, links, and tasks lists of a Document Workspace site.

When the user does not have sufficient rights, the HTTP error response raises an exception.

Example

The following code example returns information from a Document Workspace site by using the GetDwsMetaData method with the Minimal argument set to False. The example specifies a shared document as context for the Documents list and launches Microsoft Internet Explorer to view the formatted XML results. For more information about the full text of the helper functions used in this example, see the CanCreateDwsUrl method.

Requirements

Platforms: Microsoft Windows Server 2003

Web Reference: http://Server_Name/_vti_bin/Dws.asmx