GetDwsData Method
The GetDwsData 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 Documents list returned by the GetDwsData method.
lastUpdate String. The LastUpdate value returned in the results of a previous call to the GetDwsData or GetDwsMetadata method, or an empty string. If a list in the Document Workspace site has not changed since lastUpdate, the GetDwsData method returns "no changes" in place of list data for performance reasons.
Return Value
String An XML document fragment that contains the following information:
- Title
- LastUpdate
- User
- Members
- Assignees
- Lists (Tasks, Documents, Links)
Error Values
The following table shows errors that may be returned by the GetDwsMetaData method.
| Error Code | Description |
|---|---|
| DWSError.NoAccess (3) | The user does not have sufficient rights. |
The following table shows errors that may be returned by the GetDwsData method within the results it returns pertaining to the lists in the Document Workspace site.
| Error Code | Description |
|---|---|
| DWSError.NoAccess (3) | The user does not have sufficient rights. |
| DwsError.ListNotFound (7) | The specified list does not exist. |
| DwsError.TooManyItems (8) | The specified list contains more than 99 items. |
Remarks
The GetDwsData method returns general information about the Document Workspace site as well as its members, documents, links, and tasks.
Example
The following code example returns information from a Document Workspace site by using the GetDwsData method. 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