Egov.Fod.ServiceModels 10.0.2

Egov.Fod.ServiceModels

Enterprise-ready service models and interfaces for the Fod platform. This library provides a clean, decoupled set of DTOs (Data Transfer Objects) and service interfaces to ensure consistency across different components of the Fod ecosystem, designed for modern cloud-native and microservices architectures.

Table of Contents

• Features
• Prerequisites
• Installation
• Configuration
• Usage
  • Working with Service Interfaces
  • Using Models
• Testing
• Contributing
• Code of Conduct
• AI Assistance
• License

Features

• Service Models: Well-defined models for Apostillation, Appointments, Delivery, and Payments.
• Service Interfaces: Abstract interfaces for core service operations to allow for various implementations.
• Localization Support: Includes resource files for enum translations and multi-language support.
• Consistency: Uses established naming conventions and structures across the entire Fod platform.
• Modern .NET: Built for .NET 10+ leveraging the latest C# 14 runtime improvements and best practices.

Prerequisites

• .NET 10.0 or later

Installation

Install the package via NuGet:

dotnet add package Egov.Fod.ServiceModels

Configuration

The library includes configuration classes and models that can be easily integrated with standard .NET dependency injection.

Dependency Injection Setup

using Fod.ServiceModels.Configuration;

public void ConfigureServices(IServiceCollection services, IConfiguration configuration)
{
    // Configure Fod API settings
    services.Configure<FodApiConfiguration>(configuration.GetSection("FodApi"));
}

Usage

Working with Service Interfaces

Use the provided interfaces to implement or consume Fod services consistently:

using Fod.ServiceModels.Services;
using Fod.ServiceModels.Apostillation;

public class MyApostillationService(IApostillationService apostillationService)
{
    public async Task CheckAvailabilityAsync(Guid serviceRequestId)
    {
        var result = await apostillationService.ValidateAvailabilityDetailedAsync(new ApostillationAvailabilityRequest
        {
            ServiceRequestId = serviceRequestId,
            DocumentTypeCode = ApostillationSupportedDocuments.BirthCertificate
        });

        if (result.IsAvailable)
        {
            Console.WriteLine("Apostillation is available!");
        }
    }
}

Using Models

The library provides a rich set of models for various Fod domains:

using Fod.ServiceModels.Apostillation;

var request = new ApostillationAvailabilityRequest
{
    ServiceRequestId = Guid.NewGuid(),
    DocumentTypeCode = "BIRTH_CERT",
    ServiceTypeCode = "STANDARD"
};

Testing

The solution includes a comprehensive test suite using xUnit and FluentAssertions.

Running the tests

dotnet test

Contributing

Contributions are welcome! Please read CONTRIBUTING.md for guidelines on how to get started.

Code of Conduct

This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code.

AI Assistance

This repository contains an AGENTS.md file with instructions and context for AI coding agents to assist in development, ensuring consistency in code style and project structure.

License

This project is licensed under the MIT License.