3.1.4.9.2.2 GetWebResponse

  • Article

The definition of GetWebResponse specifies the result of GetWeb operation:

 <s:element name="GetWebResponse">
   <s:complexType>
     <s:sequence>
       <s:element minOccurs="1" maxOccurs="1" name="GetWebResult" type="s:unsignedInt" />
       <s:element minOccurs="1" maxOccurs="1" name="sWebMetadata" type="tns:_sWebMetadata" />
       <s:element minOccurs="1" maxOccurs="1" name="vWebs" type="tns:ArrayOf_sWebWithTime" />
       <s:element minOccurs="1" maxOccurs="1" name="vLists" type="tns:ArrayOf_sListWithTime" />
       <s:element minOccurs="0" maxOccurs="1" name="vFPUrls" type="tns:ArrayOf_sFPUrl" />
       <s:element minOccurs="0" maxOccurs="1" name="strRoles" type="s:string" />
       <s:element minOccurs="0" maxOccurs="1" name="vRolesUsers" type="tns:ArrayOfString" />
       <s:element minOccurs="0" maxOccurs="1" name="vRolesGroups" type="tns:ArrayOfString" />
     </s:sequence>
   </s:complexType>
 </s:element>

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

sWebMetadata: A _sWebMetadata (section 3.1.4.9.3.2). that specifies metadata information about the context site.

vWebs: An ArrayOf_sWebWithTime (section 2.2.4.4) that specifies information about all the subsites in the context site.

vLists: An ArrayOf_sListWithTime (section 3.1.4.9.3.3) that specifies information about all the lists in the context site.

vFPUrls: An ArrayOf_sFPUrl (section 2.2.4.3) that the protocol server MUST set to null.

strRoles: A string contains a XML node specifying information of all the role definition in the site. The schema of the strRoles is as defined in section 3.1.4.9.2.4. If the context site has no external security provider, the protocol server MUST return information about all the role definitions in the context site otherwise it MUST be null.

vRolesUsers: An ArrayOfString (section 2.2.4.5) in which each string in the array is a XML node specifying information of all the users in a role definition. Number of XML nodes in the array MUST be equal to the number of role definitions in the context site. Each XML node element in the array MUST have a schema as defined in section 2.2.4.11. If the context site has no external security provider, the protocol server MUST return user information for all the roles definitions of the context site otherwise it MUST be null.

vRolesGroups: An ArrayOfString (section 2.2.4.5) in which each string in the array is a XML node specifying information about all the groups in a role definition. Number of XML nodes in the array MUST be equal to the number of role definitions in the context site. Each XML node element in the array MUST have a schema as defined in Groups, as specified section 2.2.4.8. If the context site has no external security provider, the protocol server MUST return group information for all the role definitions of the context site in vRolesGroup otherwise it MUST be null.

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.