Share via

3.1.4.13 GetAllFriendlyUrls

  • Article

This operation obtains all the friendly URLs in the site.<18> 

 <wsdl:operation name="GetAllFriendlyUrls" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
   <wsdl:input message="tns:GetAllFriendlyUrlsSoapIn"/>
   <wsdl:output message="tns:GetAllFriendlyUrlsSoapOut"/>
 </wsdl:operation>

The protocol client initiates the operation by sending a GetAllFriendlyUrlsSoapIn message to the protocol server, as specified in section 3.1.4.13.1.1

The protocol server MUST attempt to build an ArrayOfFriendlyUrl element, as specified in section 3.1.4.13.1.2 and section 2.2.4.4, to send to the protocol client. The following conditions must be filled:

  • The protocol server MUST enumerate all the friendly URLs in the site and MUST create a FriendlyUrl object, as specified in section 2.2.4.5, for each friendly URL and add it to the ArrayOfFriendlyUrl which is returned.

  • If there are a large number of friendly URLs then the protocol server MUST return ArrayOfFriendlyUrl for a subset of those URL along with a pagingToken, as specified in section 3.1.4.13.2.2 under GetAllFriendlyUrlsResponse.

  • The protocol server MUST return different subset of the ArrayOfFriendlyUrl for different values of pagingToken.

  • Protocol server MUST return a SOAP fault if there is an error processing the pagingToken.

  • If the siteId (section 3.1.4.13.2.1) or webId (section 3.1.4.13.2.1) specified does not exist or is null the protocol server MUST return a SOAP fault.

When the operation finishes execution, the protocol server MUST send a GetAllFriendlyUrlsSoapOut message (section 3.1.4.14.1.2) that includes the ArrayOfFriendlyUrl element.