Partager via

RetrieveAbsoluteAndSiteCollectionUrlRequest Class

  • Article

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

Contains the data that is needed to retrieve the absolute URL and the site collection URL for a SharePoint location record in Microsoft Dynamics CRM.

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Syntax

'Declaration
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class RetrieveAbsoluteAndSiteCollectionUrlRequest
    Inherits OrganizationRequest

[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class RetrieveAbsoluteAndSiteCollectionUrlRequest : OrganizationRequest

Example

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.

// Retrieve the absolute URL and the Site Collection URL
// of the SharePoint document location record.
RetrieveAbsoluteAndSiteCollectionUrlRequest retrieveRequest = new RetrieveAbsoluteAndSiteCollectionUrlRequest
{
    Target = new EntityReference(SharePointDocumentLocation.EntityLogicalName, _spDocLocId)
};
RetrieveAbsoluteAndSiteCollectionUrlResponse retriveResponse = (RetrieveAbsoluteAndSiteCollectionUrlResponse)_serviceProxy.Execute(retrieveRequest);

Console.WriteLine("Absolute URL of document location record is '{0}'.", retriveResponse.AbsoluteUrl.ToString());
Console.WriteLine("Site Collection URL of document location record is '{0}'.", retriveResponse.SiteCollectionUrl.ToString());

' Retrieve the absolute URL and the Site Collection URL
' of the SharePoint document location record.
Dim retrieveRequest As RetrieveAbsoluteAndSiteCollectionUrlRequest =
 New RetrieveAbsoluteAndSiteCollectionUrlRequest With {
  .Target = New EntityReference(SharePointDocumentLocation.EntityLogicalName, _spDocLocId)
 }
Dim retriveResponse As RetrieveAbsoluteAndSiteCollectionUrlResponse =
 CType(_serviceProxy.Execute(retrieveRequest), RetrieveAbsoluteAndSiteCollectionUrlResponse)

Console.WriteLine("Absolute URL of document location record is '{0}'.", retriveResponse.AbsoluteUrl.ToString())
Console.WriteLine("Site Collection URL of document location record is '{0}'.", retriveResponse.SiteCollectionUrl.ToString())

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

Usage

Pass an instance of this class to the Execute method, which returns an instance of the RetrieveAbsoluteAndSiteCollectionUrlResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the SharepointDocumentLocation and SharepointSite entities and access rights on the specified record in the Target parameter. For a list of the required privileges, see RetrieveAbsoluteAndSiteCollectionUrl Privileges.

Notes for Callers

This message works completely if your target server is SharePoint Server 2010 or SharePoint Server 2010 online. However, if your target server is SharePoint Server 2007, this message partially works where a blank value is returned for the SiteCollectionUrl property.

For SharePoint Server 2010 or SharePoint Server 2010 Online, this message works completely only if:

  • The List Component is installed on the SharePoint site collection on the target SharePoint Server.

  • The location record for the parent SharePoint site collection exists in Microsoft Dynamics CRM. In addition, the SharePointSite.IsGridPresent attribute must be set to true when you create the parent location record.

Otherwise, a blank value is returned for the SiteCollectionUrl property.

Inheritance Hierarchy

System.Object
   Microsoft.Xrm.Sdk.OrganizationRequest
    Microsoft.Crm.Sdk.Messages.RetrieveAbsoluteAndSiteCollectionUrlRequest

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)

Target Platforms

Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),

Change History

See Also

Reference

RetrieveAbsoluteAndSiteCollectionUrlRequest Members
Microsoft.Crm.Sdk.Messages Namespace
RetrieveAbsoluteAndSiteCollectionUrlResponse

Other Resources

Actions on SharePoint Location Records
Sample: Retrieve Absolute URL and Site Collection URL of a Location Record
SharePointDocumentLocation Entity Messages and Methods
SharePointSite Entity Messages and Methods

Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.