RetrieveExchangeRateRequest Class

Artikkeli
10/20/2016

Applies To: Dynamics CRM 2015

Contains the data that is needed to retrieve the exchange rate.

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

Inheritance Hierarchy

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

Syntax

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

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

[<Sealed>]
[<DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")>]
type RetrieveExchangeRateRequest = 
    class
        inherit OrganizationRequest
    end

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

Constructors

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

Properties

	Name	Description
	ExtensionData	Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)
	Item[String]	Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)
	Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	RequestId	Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)
	RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	TransactionCurrencyId	Gets or sets the ID of the currency. Required.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Remarks

Message Availability

This message works regardless whether the caller is connected to the server or offline.

Usage

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

Privileges and Access Rights

To perform this action, the caller must have privileges on the TransactionCurrency entity and access rights to the specified record in the TransactionCurrencyId property.

For a complete list of the required privileges, see RetrieveExchangeRate message privileges.

Examples

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.


// Connect to the Organization service. 
// The using statement assures that the service proxy will be properly disposed.
using (_serviceProxy = new OrganizationServiceProxy(serverConfig.OrganizationUri, serverConfig.HomeRealmUri,serverConfig.Credentials, serverConfig.DeviceCredentials))
// using the service context makes retrieving entities easier
using (_context = new ServiceContext(_serviceProxy))
{
    // This statement is required to enable early-bound type support.
    _serviceProxy.EnableProxyTypes();

    String currentOrganizatoinUniqueName = GetCurrentOrganizationName(serverConfig);

    CreateRequiredRecords();

    RetrieveExchangeRateRequest request = new RetrieveExchangeRateRequest()
    {
        TransactionCurrencyId = _currency.Id
    };
    RetrieveExchangeRateResponse response = 
        (RetrieveExchangeRateResponse)_serviceProxy.Execute(request);
    Console.WriteLine("  Retrieved exchange rate for created currency");

    // get the base currency for the current org
    var baseCurrencyName = 
        (from currency in _context.TransactionCurrencySet
         join org in _context.OrganizationSet 
         on currency.Id equals org.BaseCurrencyId.Id
         where org.Name == currentOrganizatoinUniqueName
         select currency.CurrencyName).FirstOrDefault();
    Console.WriteLine("  This organization's base currency is {0}",
        baseCurrencyName);

    Console.WriteLine(
        "  The conversion from {0} -> {1} is {2}",
        _currency.CurrencyName,
        baseCurrencyName,
        response.ExchangeRate);

    DeleteRequiredRecords(promptforDelete);
}


' Connect to the Organization service. 
' The using statement assures that the service proxy will be properly disposed.
_serviceProxy = ServerConnection.GetOrganizationProxy(serverConfig)
Using _serviceProxy
    ' using the service context makes retrieving entities easier
    _context = New ServiceContext(_serviceProxy)
    Using _context
        ' This statement is required to enable early-bound type support.
        _serviceProxy.EnableProxyTypes()

        Dim currentOrganizatoinUniqueName As String = GetCurrentOrganizationUniqueName(serverConfig)

        CreateRequiredRecords()

        Dim request As New RetrieveExchangeRateRequest() With
            {
                .TransactionCurrencyId = _currency.Id
            }
        Dim response As RetrieveExchangeRateResponse =
            CType(_serviceProxy.Execute(request), 
                RetrieveExchangeRateResponse)
        Console.WriteLine("  Retrieved exchange rate for created currency")

        ' get the base currency for the current org
        Dim baseCurrencyName = ( _
            From currency In _context.TransactionCurrencySet _
            Join org In _context.OrganizationSet On currency.Id Equals org.BaseCurrencyId.Id _
            Where org.Name.Equals(serverConfig.OrganizationName) _
            Select currency.CurrencyName).First()
        Console.WriteLine("  This organization's base currency is {0}", baseCurrencyName)

        Console.WriteLine("  The conversion from {0} -> {1} is {2}",
                          _currency.CurrencyName, baseCurrencyName, response.ExchangeRate)

        DeleteRequiredRecords(promptforDelete)
    End Using
End Using

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.

Jaa