3.1.4.13 GetURLSegments

  • Article

The GetURLSegments operation is used to get the identifiers of a site, list, or list item depending on the specified URL. The behavior of the operation depends on the specified URL.

 <wsdl:operation name="GetURLSegments">
     <wsdl:input message="GetURLSegmentsSoapIn" />
     <wsdl:output message="GetURLSegmentsSoapOut" />
 </wsdl:operation>

The protocol client sends a GetURLSegmentsSoapIn request message, and the protocol server responds with a GetURLSegmentsSoapOut response message, as follows:

  1. The response message from the protocol server contains different GUIDs and identifiers depending on the type of element addressed by the strURL parameter, as follows:

    • If the strURL parameter is the URL of the context site<38>, and if the context site has an external security provider, the protocol server MUST return the GUID of the site and the GUID of the external security provider.

    • If the strURL parameter is a URL of a list item within the context site<39>, the protocol server MUST return:

      • The GUID of the list that contains the list item. This GUID MUST be enclosed in curly braces ({}).

      • The identification of the list item.

    • Else if the strURL parameter is a URL of a list within the request site<40>, the protocol server MUST return the GUID of the list. This GUID MUST be enclosed in curly braces ({}).

    • Else if the strURL parameter is a URL of a document within the context site<41>, the protocol server MUST return:

      • The GUID of the list that contains the document list item. The GUID MUST be enclosed in curly braces ({}).

      • The identification of the document list item.

If the input URL matches any of the preceding scenarios, the protocol server MUST return true for GetURLSegmentsResult parameter. Otherwise, the protocol server MUST return false. If the input URL is empty, the protocol server MUST raise an error.