RetrieveOrganizationRequest Class

Article
10/20/2016

Applies To: Dynamics CRM 2015

Contains the data that is needed to retrieve information about an organization.

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.RetrieveOrganizationRequest

Syntax

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

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

[<Sealed>]
[<DataContractAttribute(Name = "RetrieveOrganizationRequest",
    Namespace = "https://schemas.microsoft.com/xrm/2011/Contracts/Discovery")>]
type RetrieveOrganizationRequest = 
    class
        inherit DiscoveryRequest
    end

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

Constructors

	Name	Description
	RetrieveOrganizationRequest()	Initializes a new instance of the RetrieveOrganizationRequest class.

Properties

	Name	Description
	AccessType	Gets or sets the access type of the organization’s service endpoint.
	ExtensionData	Gets or sets the structure that contains extra data. Optional.(Inherited from DiscoveryRequest.)
	Release	Indicates the applicable version of Microsoft Dynamics CRM.
	UniqueName	Gets or sets the unique name of the 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 CRM.

Examples


// Retrieve details about a single organization discoverable via the Discovery service.
//
RetrieveOrganizationRequest orgRequest =
    new RetrieveOrganizationRequest()
    {
        UniqueName = organizations.Details[organizations.Details.Count -1].UniqueName,
        AccessType = EndpointAccessType.Default,
        Release = OrganizationRelease.Current
    };
RetrieveOrganizationResponse org =
    (RetrieveOrganizationResponse)service.Execute(orgRequest);


' Retrieve details about a single organization discoverable via the
' Discovery service.
Dim orgRequest As New RetrieveOrganizationRequest() With { _
    .UniqueName = organizations.Details(organizations.Details.Count - 1).UniqueName, _
    .AccessType = EndpointAccessType.Default, .Release = OrganizationRelease.Current}
Dim org As RetrieveOrganizationResponse = CType(service.Execute(orgRequest), RetrieveOrganizationResponse)

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.

Share via