EC.DynamicsClient 5.4.0

Introduction

This library Dynamics Client wraps calls to Dynamics 365 so you can use this to extend Dynamics 365.

Getting Started

Code Samples

namespace EC.DynamicsClient.CodeSamples;

using EC.DynamicsClient;

using Microsoft.Extensions.DependencyInjection;

using System;
using System.Threading.Tasks;

/// <summary>
/// Dynamics Client Code Samples
/// </summary>
public static class Dynamics_Client_Code_Samples
{
    /// <summary>
    /// Default Dynamics Client Setup Startup
    /// </summary>
    /// <param name="services">The service collection</param>
    /// <returns>The updated service collection</returns>
    public static IServiceCollection Default_Dynamics_Client_Setup_Startup(
        this IServiceCollection services) => services
        .AddDynamicsClients();

    /// <summary>
    /// Default Dynamics Client Setup Startup with Keys
    /// </summary>
    /// <param name="services">The service collection</param>
    /// <param name="authorityKeyName">The authority key name</param>
    /// <param name="clientIdKeyName">The client ID key name</param>
    /// <param name="clientSecretKeyName">The client secret key name</param>
    /// <param name="serviceEndpointKeyName">The service endpoint key name</param>
    /// <param name="scopesKeyName">The scopes key name</param>
    /// <param name="retryCountKeyName">The retry count key name</param>
    /// <returns>The updated service collection</returns>
    public static IServiceCollection Default_Dynamics_Client_Setup_Startup_with_Keys(
        this IServiceCollection services,
        string authorityKeyName, string clientIdKeyName, string clientSecretKeyName,
        string serviceEndpointKeyName, string scopesKeyName, string retryCountKeyName)
        => services
            .AddDynamicsClients(
                authorityKeyName,
                clientIdKeyName,
                clientSecretKeyName,
                serviceEndpointKeyName,
                scopesKeyName,
                retryCountKeyName);

    /// <summary>
    /// Default Dynamics Query Client Usage
    /// </summary>
    /// <param name="dynamicsQueryClient">The dynamics query client</param>
    /// <returns>A task representing the asynchronous operation</returns>
    public static async Task Default_Dynamics_Query_Client_Usage(
        IDynamicsQueryClient dynamicsQueryClient)
    {
        try
        {
            var entityCollection = await dynamicsQueryClient.ThrowIfNull()
                .Get<Contact>(
                    ContactField.EntitySetName
                    .Query()
                    .Where([ // sample filter records
                        ContactField.FullName.Contain("Bob"),
                        ContactField.FullName.Starts_With("Dan"),
                        ContactField.OwnerId.Equal_User_Id()
                    ])
                    .Top(10)
                    .Select([ // sample select fields
                        ContactField.FirstName,
                        ContactField.LastName,
                        ContactField.ContactId,
                        ContactField.CreatedBy.ToLookup(),
                    ])
                    .OrderBy([ // sample order by expressions
                        ContactField.CreatedBy.Order_By()
                    ])
                    .ExpandOn( // sample expand on expressions
                        ContactField.ec_Account
                        .Expand()
                        .Select([AccountField.AccountId])
                        .Where([
                            AccountField.OwnerId.Equal_User_Id()
                        ])
                        .Build())
                    .Where([ // sample lambda expressions
                        Lambda.All(ContactOneToMany.account_primary_contact, [
                            Lambda.StartsWith(AccountField.Name, "S"),
                            Lambda.EndsWith(AccountField.Name, "h"),
                            Lambda.Contains(AccountField.Name, "Smith"),
                            Lambda.Equals(AccountField.StatusCode, account_statuscode.Active),
                            new EqualsLambdaExpression("null", "null")
                        ]),
                    ])
                    .Build())
                .ConfigureAwait(false);

            if (entityCollection?.Entities is not null)
            {
                foreach (var item in entityCollection.Entities)
                {

                }
            }
        }
        catch (FailedStatusCodeException exception)
        {
            var dynamics_error_message = exception.Error?.GetMessage();
            var dynamics_error_stacktrace = exception.Error?.GetStackTrace();
        }
    }

    /// <summary>
    /// Default Dynamics Manager Client Usage
    /// </summary>
    /// <param name="dynamicsManagerClient">The dynamics manager client</param>
    /// <returns>A task representing the asynchronous operation</returns>
    public static async Task Default_Dynamics_Manager_Client_Usage(
        IDynamicsManagerClient dynamicsManagerClient)
    {
        try
        {
            var createResponse = await dynamicsManagerClient.ThrowIfNull()
                .Create(new CreateRequest<Contact>(ContactField.EntitySetName, new()
                {
                    FirstName = "test first name",
                    LastName = "test last name",
                }, headerSet: new HeaderSet([new AddPrefer([new ReturnRepresentation()])])
            )).ConfigureAwait(false);

            var created_contact = await createResponse.GetData().ConfigureAwait(false);
            var contact_id = created_contact?.ContactId;
        }
        catch (FailedStatusCodeException exception)
        {
            var error_message = exception.Error?.GetMessage();
            var error_stack_trace = exception.Error?.GetStackTrace();
        }
    }
}

Contribute

To Contribute, clone repository locally then create a new branch from master/main and make any changes on that branch. When happy with changes create pull request for review.