3.1.4.6.2.2 GetSiteResponse

  • Article

The GetSiteResponse element specifies the result from GetSite operation:

 <s:element name="GetSiteResponse">
   <s:complexType>
     <s:sequence>
       <s:element minOccurs="1" maxOccurs="1" name="GetSiteResult"
                  type="s:unsignedInt" />
       <s:element minOccurs="1" maxOccurs="1" name="sSiteMetadata"
                  type="tns:_sSiteMetadata" />
       <s:element minOccurs="0" maxOccurs="1" name="vWebs"
                  type="tns:ArrayOf_sWebWithTime" />
       <s:element minOccurs="0" maxOccurs="1" name="strUsers" type="s:string" />
       <s:element minOccurs="1" maxOccurs="1" name="strGroups" type="s:string" />
       <s:element minOccurs="1" maxOccurs="1" name="vGroups"
                  type="tns:ArrayOfString" />
     </s:sequence>
   </s:complexType>
 </s:element>

GetSiteResult: An unsigned integer that specifies the status of the operation. On successful execution of the operation, the protocol server MUST set it to 0.

sSiteMetadata: A _sSiteMetadata complex type (section 3.1.4.6.3.1) that specifies the metadata information about the site collection.

vWebs: An ArrayOf_sWebWithTime complex types (section 2.2.4.4) that specifies an array of information about all the subsites in the site collection. vWebs MUST be returned only if the site collection is a small site collection and the current user is the administrator of the site collection.

strUsers: A string that protocol server MUST set to null.

strGroups: A string that contains an XML node whose schema is as specified in section 2.2.4.8. strGroups specifies information about all the groups in the site collection.

vGroups: An ArrayOfString (section 2.2.4.5) that specifies information about the users of all the groups for the site collection. Each string in the array is an XML node containing information about all the users of a group. The number of strings in the array MUST be equal to the number of groups in strGroups. The order of user information in vGroups MUST correspond with the order of groups in strGroups. Each XML node is as defined [MS-SITEDATS] section 2.2.4.24.

If the protocol server encounters an error during the execution of this operation, a SOAP fault MUST be returned. There are no error(s) specific to this operation.