3.1.4.8.2.2 GetDwsMetaDataResponse

Article
05/16/2023

This element contains the protocol server response to a GetDwsMetaData operation. The element contains a string that is stand-alone XML, defined as follows:

       <s:element name="GetDwsMetaDataResponse">
         <s:complexType>
           <s:sequence>
             <s:element minOccurs="0" maxOccurs="1"
                        name="GetDwsMetaDataResult" type="tns:GetDwsMetaDataResultType"/>
           </s:sequence>
         </s:complexType>
       </s:element>

GetDwsMetaDataResult: This element contains a string that is stand-alone XML, encoded either as an Error element as specified in section 2.2.3.2 or a Results element defined as follows:

 <s:complexType name="GetDwsMetaDataResultType">
   <s:choice>
     <s:element ref="tns:Error"/>
     <s:element name="Results">
        <xs:complexType>
         <xs:sequence>
            <xs:element name="SubscribeUrl" type="xs:string" minOccurs="0"/>
            <xs:element name="MtgInstance" type="xs:string"/>
            <xs:element name="SettingUrl" type="xs:string"/>
            <xs:element name="PermsUrl" type="xs:string"/>
            <xs:element name="UserInfoUrl" type="xs:string"/>
            <xs:element ref="tns:Roles"/>
            <xs:element ref="tns:Schema" minOccurs="0" maxOccurs="3"/>
            <xs:element ref="tns:ListInfo" minOccurs="0" maxOccurs="3"/>
            <xs:element name="Permissions">
               <xs:complexType>
                  <xs:choice>
                   <xs:element ref="tns:Error"/>
                   <xs:sequence>
                       <xs:element name="ManageSubwebs" minOccurs="0"/>
                       <xs:element name="ManageWeb" minOccurs="0"/>
                       <xs:element name="ManageRoles" minOccurs="0"/>
                       <xs:element name="ManageLists" minOccurs="0"/>
                       <xs:element name="InsertListItems" minOccurs="0"/>
                       <xs:element name="EditListItems" minOccurs="0"/>
                       <xs:element name="DeleteListItems" minOccurs="0"/>
                  </xs:sequence>
                 </xs:choice>
               </xs:complexType>
            </xs:element>
            <xs:element name="HasUniquePerm"/>
            <xs:element name="WorkspaceType"/>
            <xs:element name="IsADMode"/>
            <xs:element name="DocUrl"/>
            <xs:element name="Minimal"/>
            <s:element ref="tns:Results"/>
         </xs:sequence>
       </xs:complexType>
    </s:element>
   </s:choice>
 </s:complexType>

If the element is an Error, it MUST contain an error code as specified in section 2.2.3.2. It MUST contain one of the error codes from the following table.

Error code	Description
DocumentNotFound	The site or document could not be found.
NoAccess	The authenticated user is not permitted to access this information. The Error element MUST contain the URL of a page where the user can request access permission.<8>
ServerFailure	The protocol server encountered an unspecified error during operation processing.

SubscribeUrl: This is the URI of a page that enables users to subscribe to changes in the document specified in the parameters. See [MS-OSALER] and [MS-ALERTSS] for more information about alert subscriptions.

MtgInstance: If the document element specifies a meeting item, this element MUST represent a string that contains the meeting information. The meeting information contains the instance identifier of the meeting. Otherwise, the element SHOULD be empty.

SettingUrl: URI of a page that enables workspace settings to be modified.

PermsUrl: URI of a page that enables the workspace permissions settings to be modified.

UserInfoUrl: URI of a page that enables the list of users to be modified.

Roles: Specifies the roles that apply to the workspace. This element MUST conform to the element specification in section 2.2.3.6.

Schema: Contains the schema information for the following workspace lists appearing in a sequence as below. The element MUST conform to the Schema element in the xml element specified in section 2.2.4.2.

Tasks<9>
Documents
Links

ListInfo: This element contains list information for the following workspace lists appearing in a sequence as below. This element MUST conform to the ListInfo element specified in section 3.1.4.8.2.3.

Tasks
Documents
Links

Permissions: This element contains the permissions of the authenticated user for this Document Workspace. This element contains elements that indicate permissible operations. The list of elements that MAY be present are described in the WSDL, specified in section 6. Each element represents the ability to perform the action for which it is named.

HasUniquePerm: Set to True if, and only if, the workspace has custom role assignments; otherwise, if role assignments are inherited from the site in which the workspace is created, set to False.

WorkspaceType: This value MUST be "DWS", "MWS", or an empty string. "DWS" identifies the workspace as a Document Workspace; "MWS" identifies it as a Meeting Workspace. A Meeting Workspace is a convenient and centralized place for project collaboration and meeting proceedings. If the site is not one of those types, an empty string MUST be returned.

IsADMode: Set to True if, and only if, the workspace is set to Active Directory mode, a mode in which, when new users are created in the site, new site member accounts are created automatically in Active Directory Domain Services (AD DS); otherwise set to False.

DocUrl: This SHOULD be set to the value of document from the GetDwsMetaData request or be empty if the value of document is not specified in the GetDwsMetaData request.

Minimal: This element contains the minimal flag from the GetDwsMetaData request. This value MUST match the value in the request.

Results: This element is identical to Results element of the GetDwsDataResult element specified in section 3.1.4.7.2.2. Note the effect of the minimal flag on the contained elements.

3.1.4.8.2.2 GetDwsMetaDataResponse

Additional resources