RetrieveOrganizationsRequest Class

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

Contains the data that is needed to retrieve information on all organizations that the logged on user belongs to.

Namespace: Microsoft.Xrm.Sdk.Discovery
Assembly: Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)

Syntax

'Declaration
<DataContractAttribute(Name:="RetrieveOrganizationsRequest", Namespace:="https://schemas.microsoft.com/xrm/2011/Contracts/Discovery")> _
Public NotInheritable Class RetrieveOrganizationsRequest
    Inherits DiscoveryRequest

[DataContractAttribute(Name="RetrieveOrganizationsRequest", Namespace="https://schemas.microsoft.com/xrm/2011/Contracts/Discovery")] 
public sealed class RetrieveOrganizationsRequest : DiscoveryRequest

Example

// Retrieve details about all organizations discoverable via the
// Discovery service.
RetrieveOrganizationsRequest orgsRequest =
    new RetrieveOrganizationsRequest()
    {
        AccessType = EndpointAccessType.Default,
        Release = OrganizationRelease.Current
    };
RetrieveOrganizationsResponse organizations =
    (RetrieveOrganizationsResponse)service.Execute(orgsRequest);

' Retrieve details about all organizations discoverable via the
' Discovery service.
Dim orgsRequest As New RetrieveOrganizationsRequest() With { _
    .AccessType = EndpointAccessType.Default, .Release = OrganizationRelease.Current}
Dim organizations As RetrieveOrganizationsResponse = _
    CType(service.Execute(orgsRequest), RetrieveOrganizationsResponse)

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.

Privileges and Access Rights

To perform this action, the caller must have a system user account in Microsoft Dynamics CRM.

Inheritance Hierarchy

System.Object
   Microsoft.Xrm.Sdk.Discovery.DiscoveryRequest
    Microsoft.Xrm.Sdk.Discovery.RetrieveOrganizationsRequest

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

RetrieveOrganizationsRequest Members
Microsoft.Xrm.Sdk.Discovery Namespace
RetrieveOrganizationsResponse

Other Resources

Discover the URL for Your Organization With IDiscoveryService Web Service
Discovery Service Messages (Request and Response Classes)
Sample: Access the Discovery Service

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