RetrieveOrganizationsRequest Class
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, 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)
Inheritance Hierarchy
System.Object
Microsoft.Xrm.Sdk.Discovery.DiscoveryRequest
Microsoft.Xrm.Sdk.Discovery.RetrieveOrganizationsRequest
Syntax
[DataContractAttribute(Name = "RetrieveOrganizationsRequest",
Namespace = "https://schemas.microsoft.com/xrm/2011/Contracts/Discovery")]
public sealed class RetrieveOrganizationsRequest : DiscoveryRequest
<DataContractAttribute(Name := "RetrieveOrganizationsRequest",
Namespace := "https://schemas.microsoft.com/xrm/2011/Contracts/Discovery")>
Public NotInheritable Class RetrieveOrganizationsRequest
Inherits DiscoveryRequest
Constructors
Name | Description | |
---|---|---|
RetrieveOrganizationsRequest() | Initializes a new instance of the RetrieveOrganizationsRequest class. |
Properties
Name | Description | |
---|---|---|
AccessType | Gets or sets the access type of the organizations’ service endpoint. |
|
ExtensionData | Gets or sets the structure that contains extra data. Optional.(Inherited from DiscoveryRequest.) |
|
IsInternalCrossGeoServerRequest | For internal use only. |
|
Release | Get or sets the release version of a Microsoft Dynamics 365 organization. |
Methods
Name | Description | |
---|---|---|
Equals(Object) | (Inherited from Object.) |
|
GetHashCode() | (Inherited from Object.) |
|
GetType() | (Inherited from Object.) |
|
ToString() | (Inherited from Object.) |
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 365.
Examples
// 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)
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.
See Also
RetrieveOrganizationsResponse
Microsoft.Xrm.Sdk.Discovery Namespace
Discover the URL for your organization using the Organization Service
Discovery service messages (request and response classes)
Sample: Access the Discovery service
Return to top
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright