ASP.NET Core 3 Web API to manage clients and legal cases

• Description
• Technologies used
• Live Site
• Set up
• Configuration: Azure web app and Azure Active Directory
• Configuration: Authentication / Authorization
• Configuration: Database
• Run Application
• Endpoints
• Related Repos

ClientsManager is an ASP.NET Core 3.1 Web API.

Using ClientsManager you can manage your clients, legal cases, and billable activities.

ASP.NET Core 3.1, C#, AutoMapper, Swagger, Serilog, Entity Framework Core, SQL Server

ClientsManager API

Complete the following steps to start a new project (NEW-PROJECT-NAME):

1. Clone this repository to your local machine git clone https://github.com/rodrigohervas/ClientManagerAPI.git NEW-PROJECT-NAME
2. cd into the cloned repository
3. Make a fresh start of the git history for this project with rm -r -Force .git, amd then git init
4. Make sure that the .gitignore file is encoded as 'UTF-8'

Note. This server can be used with the following client repo: xxxx

Before using the API there are several steps to follow in order to create the API in Azure App Services and register it in Azure Active Directory:

1. Register the API in Azure Active Directory (you'll need to have an Azure Active Directory tenant configured)

Recommended Read: Protected Web API app registration

2. Configure the API registration in Azure Active Directory (the registration must expose at least one scope/role in the Expose an API section)

3. In appsettings.json / secrets.json, add the following configuration (get your config data from the Azure AD API registration):

{
"AzureAd": {
      "ClientId": "your-API-Azure-client-Id",
      "Instance": "https://login.microsoftonline.com/",
      "TenantId": "your-azure-AD-tenant-Id",
      "APIApplicationIdUri": "api://your-API-Azure-client-Id",
      "ClientAudience": "your-client-Azure-AD-Id", //This is the intended recipient(s) for this token (the calling client Id in Azure AD).
      "APIAudience": "your-API-Azure-client-Id" //This claim identifies the audience for this token (your API Azure AD Client Id)
  }
}

4. Create a web app in Azure App Services for your API

Recommended read: Publish web app to Azure

5. Publish the API to Azure

6. Configure the web app created in Azure App Services, specially the appsettings in Azure (or a Key Vault if preferred).

All API requests must be made using an access_token. The access_token is a JWT Bearer Token, issued by Azure Active Directory.

After the API configuration in Azure Web Services and Azure Active Directory the app is ready to authenticate JWT Tokens.

Regarding Token validation, check ClientsManager.WebAPI.Authentication.AddAuthenticationExtensions.cs, called from the Startup.ConfigureServices method.

Authorization is configured at the controller level using the [Authorize] attribute.

During the API Publish process you can create the Database in Azure. If you want to run the scripts, you can find them in ClientsManager.SQLscripts:

1. Run Create_ClientsManager_DB_Script.sql to create the ClientManagers database

2. Run Create_EmployeeTypes_Table_Script.sql to create the EmployeeTypes table

3. Run Create_Employees_Table_Script.sql to create the Employees table

4. Run Create_Clients_Table_Script.sql to create the Clients table

5. Run Create_Addresses_Table_Script.sql to create the Addresses table

6. Run Create_Contacts_Table_Script.sql to create the Contacts table

7. Run Create_Logs_Table_Script.sql to create the EventLogging.Logs table

Build the solution

Run the application

The API has the following endpoints:

• Clients: CRUD Clients

• LegalCases: CRUD LegalCases for a Client

• BillableActivities: CRUD BillableActivities for a LegalCase

• Addresses: CRUD Adresses for a Client

• Contacts: CRUD Contacts for a Client

• Employees: CRUD Employees for a LegalCase

• EmployeeTypes: CRUD EmployeeTypes for an Employee

• Description: returns an array of Client objects, paged by the provided pageNumber and pageSize

• Request params:

• Response:

A collection of Client objects:

• Description: returns a Client object for the provided client id

• Request params:

• Response:

A Client object:

• Description: returns an array of Client objects, with its related LegalCases

• Request params:

• Response:

An array of Client objects, with its LegalCase objects:

• Description: returns a Client object for the provided client id, including its related Address objects

• Request params:

• Response:

A Client object:

• Description: returns a Client object for the provided id, including its related Contact objects

• Request params:

• Response:

A Client object with its related Contact objects:

• Description: creates a Client object

• Request params:

• Response:

The Client object created.

• Description: updates an existing Client object

• Request params:

• Response:

The Client object updated

• Description: deletes an existing Client object

• Request params:

• Response:

The number of Client objects deleted

• Description: returns an array of LegalCase objects, paged by the provided pageNumber and pageSize

• Request params:

• Response:

An array of LegalCase of objects.

• Description: returns all LegalCases for a provided Client id

• Request params:

• Response:

An array of LegalCase objects.

• Description: returns a LegalCase object for a provided id

• Request params:

• Response:

A LegalCase object.

• Description: returns a LegalCase object for a provided id, with all its related BillableActivity objects

• Request params:

• Response:

A LegalCase object

• Description: creates a LegalCase object

• Request params:

• Response:

The created LegalCase object

• Description: updates an existing LegalCase object

• Request params:

• Response:

The updated LegalCase object

• Description: deletes an existing LegalCase object

• Request params:

• Response:

The number of deleted LegalCase objects

• Description: returns an array of BillableActivity objects, paged by the provided pageNumber and pageSize

• Request params:

• Response:

An array of BillableActivity objects.

• Description: returns the an array of BillableActivity objects, for a provided Employee id

• Request params:

• Response:

An array of BillableActivity objects

• Description: returns an array of BillableActivity objects, for a provided LegalCase id

• Request params:

• Response:

A LegalCase object.

An array of BillableActivity objects

• Description: returns a BillableActivity object, for a provided id

• Request params:

• Response:

A BillableActivity object.

• Description: creates a BillableActivity object

• Request params:

• Response:

The created BillableActivity object.

• Description: updates an existing BillableActivity object

• Request params:

• Response:

The updated BillableActivity object.

• Description: deletes an existing BillableActivity object

• Request params:

• Response:

The number of deleted BillableActivity objects

• Description: returns an array of Address objects, paged by the provided pageNumber and pageSize

• Request params:

• Response:

An array of Address objects.

• Description: returns an array of Address objects, for a provided Client id

• Request params:

• Response:

An array of Address objects

• Description: returns an Address object, for a provided id

• Request params:

• Response:

An Address object

• Description: returns an Address object, for a provided id, with its related Contact objects

• Request params:

• Response:

An Address object

• Description: creates an Address object

• Request params:

• Response:

The created Address object.

• Description: updates an existing Address object

• Request params:

• Response:

The updated Address object.

• Description: deletes an existing Address object

• Request params:

• Response:

The number of deleted Address objects

• Description: returns an array of Contact objects, paged by the provided pageNumber and pageSize

• Request params:

• Response:

An array of Contact objects

• Description: returns an array of Contact objects, for a provided Client id

• Request params:

• Response:

An array of Contact objects

• Description: returns a Contact object, for a provided id

• Request params:

• Response:

A Contact object

• Description: returns a Contact object, for a provided id, with its related Address objects

• Request params:

• Response:

A Contact object

• Description: creates a Contact object

• Request params:

• Response:

The created Contact object.

• Description: updates an existing Contact object

• Request params:

• Response:

The updated Contact object.

• Description: deletes an existing Contact object

• Request params:

• Response:

The number of deleted Contact objects

• Description: returns an array of Employee objects, paged by the provided pageNumber and pageSize

• Request params:

• Response:

An array of Employee objects

• Description: returns an array of Employee objects, for a provided id

• Request params:

• Response:

An array of Employee objects

• Description: returns an array of Employee objects, for a provided EmployeeType id

• Request params:

• Response:

An array of Employee objects

• Description: creates an Employee object

• Request params:

• Response:

The created Employee object

• Description: updates an existing Employee object

• Request params:

• Response:

The updated Employee object

• Description: deletes an existing Employee object

• Request params:

• Response:

The number of deleted Employee objects

• Description: returns an array of EmployeeType objects

• Request params:

None

• Response:

An array of EmployeeType objects

• Description: returns an EmployeeType object, for a provided id

• Request params:

• Response:

An array of Employee objects

• Description: creates an EmployeeType object

• Request params:

• Response:

The created EmployeeType object

• Description: updates an existing EmployeeType object

• Request params:

• Response:

The updated EmployeeType object

• Description: deletes an existing EmployeeType object

• Request params:

• Response:

The number of deleted EmployeeType objects

Clients Manager client - Pending