EC.DynamicsClient 5.7.0

Introduction

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

Getting Started

Code Samples

Startup

namespace EC.DynamicsClient.CodeSamples;

using EC.DynamicsClient;

using Microsoft.Extensions.DependencyInjection;

public static class Startup_Code_Samples
{
    public static IServiceCollection Default(this IServiceCollection services) => services
        .AddDynamicsClients();

    public static IServiceCollection 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);
}

Then for configuration here is the default setup in JSON format, you can have the configuration hydrate from any source being host environment variables or others as long as you follow the same structure. For Scopes you can use {dynamics_base_adress}/.default and for DynamicsServiceEndpoint you can use {dynamics_base_adress}/api/data/v9.2/

{
    "AzureAd": {
        "Instance": "https://login.microsoftonline.com/",
        "TenantId": "...",
        "ClientId": "...",
        "ClientSecret": "...",
        "Scopes": "..."
    },
    "DynamicsServiceEndpoint": "..."
}

Query Client Usage

namespace EC.DynamicsClient.CodeSamples;

using EC.DynamicsClient;

using Microsoft.Extensions.Logging;

using System;
using System.Threading.Tasks;

static class Query_Client_Usage_Code_Samples
{
    public static async Task<IResult> Query_Client_Usage(
        IDynamicsQueryClient queryClient,
        ILogger log,
        Guid user_id)
    {
        var result = await queryClient.Get_Safe<Contact>(
            ContactField
            .EntitySetName
            .Query()
            .Where([ // sample filter records
                ContactField.FullName.Not_Equal_Null(),
                ContactField.FullName.Contain("Bob"),
                ContactField.FullName.Starts_With("Dan"),
                ContactField.OwnerId.Not_Equal_Null(),
                ContactField.OwnerId.Equal_User_Id(),
                ContactField.CreatedBy.Not_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);

        return result.Match(
            invalid =>
            {
                log.LogWarning("The query that was provided is invalid.");
                return Results.Problem(
                    title: "The query that was provided is invalid.",
                    statusCode: StatusCodes.Status400BadRequest
                );
            },
            contacts =>
            {
                log.LogInformation("Contacts found and returned.");
                return Results.Ok(contacts.Entities);
            },
            not_found =>
            {
                log.LogWarning("The query that was provided did not return any results.");
                return Results.NotFound();
            },
            failed =>
            {
                log.LogError("The query that was provided resulted in a failed status response.");
                return Results.Problem(
                    title: "The query that was provided resulted in a failed status response.",
                    detail: failed.Error?.GetMessage(),
                    statusCode: StatusCodes.Status500InternalServerError,
                    extensions: [
                        new ("StackTrace", failed.Error?.GetStackTrace())
                    ]
                );
            });
    }
}

Manager Client Usage

namespace EC.DynamicsClient.CodeSamples;

using EC.DynamicsClient;

using Microsoft.Extensions.Logging;

using System.Threading.Tasks;

static class Manager_Client_Usage_Code_Samples
{
    public static async Task<IResult> Upsert_Contact_from_API_or_Web(
        this IDynamicsManagerClient managerClient,
        ILogger log,
        AlternateKey[] keys,
        Contact contact)
    {
        var result = await managerClient.Request(
            ContactField.EntitySetName.Upsert(keys, contact)
        ).ConfigureAwait(false);

        return result.Match(
            success =>
            {
                log.LogInformation("The upsert request provided completed successfully.");
                return Results.Ok();
            },
            contact =>
            {
                log.LogInformation("The upsert request provided completed successfully with the updated contact.");
                return Results.Ok(contact);
            },
            invalid =>
            {
                log.LogWarning("The upsert request that was provided is invalid.");
                return Results.Problem(
                    title: "The upsert request that was provided is invalid.",
                    statusCode: StatusCodes.Status400BadRequest
                );
            },
            failed =>
            {
                log.LogError("The upsert request that was provided resulted in a failed status response.");
                return Results.Problem(
                    title: "The upsert request that was provided resulted in a failed status response.",
                    detail: failed.Error?.GetMessage(),
                    statusCode: StatusCodes.Status500InternalServerError,
                    extensions: [
                        new ("StackTrace", failed.Error?.GetStackTrace())
                    ]
                );
            });
    }
}