EC.DynamicsClient 5.2.4

Introduction

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

Getting Started using 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>(
                    Contact
                    .EntitySet
                    .Query()
                    .Where([
                        Contact.Field_fullname.Contain("Bob"),
                        Contact.Field_fullname.Starts_With("Dan"),
                        Contact.Field_ownerid_value.Equal_User_Id()
                    ])
                    .Top(10)
                    .Select([
                        Contact.Field_firstname,
                        Contact.Field_lastname,
                        Contact.Field_contactid
                    ])
                    .OrderBy([
                        Contact.Field_createdon.Order_By()
                    ])
                    .ExpandOn(
                        Contact.Nav_Accounts
                        .Expand()
                        .Select([Account.Field_accountid])
                        .Where([
                            Account.Field_ownerid_value.Equal_User_Id()
                        ])
                        .Build())
                    .ExpandOn([
                        Contact.Nav_Subscriptions
                            .Expand()
                            .Select([Subscription.Field_subscriptionid])
                            .Where([
                                Subscription.Field_ownerid_value.Equal_User_Id()
                            ])
                            .ExpandOn([
                                Subscription.Nav_Accounts
                                    .Expand()
                                    .Select([Account.Field_accountid])
                                    .Build()
                            ])
                            .Build()
                    ])
                    .Build())
                .ConfigureAwait(false);

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

                }
            }
        }
        catch (FailedStatusCodeException exception)
        {
            var dynamics_error = await exception.Response.GetDynamicsError().ConfigureAwait(false);
            var dynamics_error_message = dynamics_error?.GetMessage();
            var dynamics_error_stacktrace = dynamics_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)
    {
        var createResponse = await dynamicsManagerClient
            .ThrowIfNull()
            .CreateAsync(new CreateRequest<Contact>(Contact.EntitySet, new()
            {
                FirstName = "test first name",
                LastName = "test last name",
            }, headerSet: new HeaderSet([new AddPrefer([new ReturnRepresentation()])]))).ConfigureAwait(false);
        if (createResponse.IsSuccessStatusCode is false)
        {
            var dynamics_error = await createResponse.GetError().ConfigureAwait(false);
            var dynamics_error_message = dynamics_error?.GetMessage();
            var dynamics_error_stacktrace = dynamics_error?.GetStackTrace();
        }

        var created_contact = await createResponse.GetData().ConfigureAwait(false);
        var contact_id = created_contact?.ContactId;
    }
}

/// <summary>
/// Dynamics Data Models
/// </summary>
class Contact
{
    public const string EntitySet = "contacts";

    public const string Field_contactid = "contactid";
    public const string Field_firstname = "firstname";
    public const string Field_lastname = "lastname";
    public const string Field_fullname = "fullname";
    public const string Field_createdon = "createdon";
    public const string Field_ownerid_value = "fullname";

    public const string Nav_Accounts = "Accounts";
    public const string Nav_Subscriptions = "Subscriptions";

    public Guid? ContactId { get; set; }
    public string FirstName { get; set; }
    public string LastName { get; set; }
}
class Account
{
    public const string EntitySet = "accounts";

    public const string Field_accountid = "accountid";
    public const string Field_ownerid_value = "_ownerid_value";

    public Guid? ContactId { get; set; }
    public string FirstName { get; set; }
    public string LastName { get; set; }
}
class Subscription
{
    public const string EntitySet = "subscriptions";

    public const string Field_subscriptionid = "subscriptionid";
    public const string Field_ownerid_value = "_ownerid_value";

    public const string Nav_Accounts = "Accounts";

    public Guid? ContactId { get; set; }
    public string FirstName { get; set; }
    public string LastName { get; set; }
}

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.