3.1.4.8 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:

  • The protocol client specifies the absolute URL of any item on the site.

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

    • If the strURL parameter is the URL of the context site 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. This GUID MUST be enclosed in curly braces ({}).

    • Otherwise, the strURL parameter is a URL of a list item within the context site, the protocol server MUST return:

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

    • The ID of the list item.

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

  • Otherwise the strURL parameter is a URL of a document within the context site, the protocol server MUST return the following:

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

    • The ID of the document list item.

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