Scaffold bulk person find endpoint (#1457)

DFE-Digital · Aug 8, 2024 · 3deed24 · 3deed24
1 parent 7d837d7
commit 3deed24
Show file tree

Hide file tree

Showing 11 changed files with 85 additions and 39 deletions.
diff --git a/...tem.Api/V3/Core/Operations/FindPersons.cs → ...ons/FindPersonByLastNameAndDateOfBirth.cs b/...tem.Api/V3/Core/Operations/FindPersons.cs → ...ons/FindPersonByLastNameAndDateOfBirth.cs
@@ -7,11 +7,11 @@
 
 namespace TeachingRecordSystem.Api.V3.Core.Operations;
 
-public record FindPersonsCommand(string LastName, DateOnly? DateOfBirth);
+public record FindPersonByLastNameAndDateOfBirthCommand(string LastName, DateOnly? DateOfBirth);
 
-public record FindPersonsResult(int Total, IReadOnlyCollection<FindPersonsResultItem> Items);
+public record FindPersonByLastNameAndDateOfBirthResult(int Total, IReadOnlyCollection<FindPersonByLastNameAndDateOfBirthResultItem> Items);
 
-public record FindPersonsResultItem
+public record FindPersonByLastNameAndDateOfBirthResultItem
 {
     public required string Trn { get; init; }
     public required DateOnly DateOfBirth { get; init; }
@@ -22,11 +22,11 @@ public record FindPersonsResultItem
     public required IReadOnlyCollection<NameInfo> PreviousNames { get; init; }
 }
 
-public class FindPersonsHandler(ICrmQueryDispatcher crmQueryDispatcher, IConfiguration configuration)
+public class FindPersonByLastNameAndDateOfBirthHandler(ICrmQueryDispatcher crmQueryDispatcher, IConfiguration configuration)
 {
     private readonly TimeSpan _concurrentNameChangeWindow = TimeSpan.FromSeconds(configuration.GetValue("ConcurrentNameChangeWindowSeconds", 5));
 
-    public async Task<FindPersonsResult> Handle(FindPersonsCommand command)
+    public async Task<FindPersonByLastNameAndDateOfBirthResult> Handle(FindPersonByLastNameAndDateOfBirthCommand command)
     {
         var contacts = await crmQueryDispatcher.ExecuteQuery(
             new GetActiveContactsByLastNameAndDateOfBirthQuery(
@@ -55,9 +55,9 @@ public async Task<FindPersonsResult> Handle(FindPersonsCommand command)
                 kvp => kvp.Key,
                 kvp => PreviousNameHelper.GetFullPreviousNames(kvp.Value, contactsById[kvp.Key], _concurrentNameChangeWindow));
 
-        return new FindPersonsResult(
+        return new FindPersonByLastNameAndDateOfBirthResult(
             Total: contacts.Length,
-            Items: contacts.Select(r => new FindPersonsResultItem()
+            Items: contacts.Select(r => new FindPersonByLastNameAndDateOfBirthResultItem()
             {
                 Trn = r.dfeta_TRN,
                 DateOfBirth = r.BirthDate!.Value.ToDateOnlyWithDqtBstFix(isLocalTime: false),

diff --git a/...gRecordSystem/src/TeachingRecordSystem.Api/V3/V20240101/Controllers/TeachersController.cs b/...gRecordSystem/src/TeachingRecordSystem.Api/V3/V20240101/Controllers/TeachersController.cs
@@ -104,9 +104,9 @@ public async Task<IActionResult> CreateDateOfBirthChange(
     [Authorize(Policy = AuthorizationPolicies.GetPerson)]
     public async Task<IActionResult> FindTeachers(
         FindTeachersRequest request,
-        [FromServices] FindPersonsHandler handler)
+        [FromServices] FindPersonByLastNameAndDateOfBirthHandler handler)
     {
-        var command = new FindPersonsCommand(request.LastName!, request.DateOfBirth!.Value);
+        var command = new FindPersonByLastNameAndDateOfBirthCommand(request.LastName!, request.DateOfBirth!.Value);
         var result = await handler.Handle(command);
 
         var response = new FindTeachersResponse()

diff --git a/...gRecordSystem/src/TeachingRecordSystem.Api/V3/V20240101/Responses/FindTeachersResponse.cs b/...gRecordSystem/src/TeachingRecordSystem.Api/V3/V20240101/Responses/FindTeachersResponse.cs
@@ -4,15 +4,15 @@
 
 namespace TeachingRecordSystem.Api.V3.V20240101.Responses;
 
-[AutoMap(typeof(FindPersonsResult))]
+[AutoMap(typeof(FindPersonByLastNameAndDateOfBirthResult))]
 public record FindTeachersResponse
 {
     public required int Total { get; init; }
     public required FindTeachersRequest Query { get; init; }
     public required IReadOnlyCollection<FindTeachersResponseResult> Results { get; init; }
 }
 
-[AutoMap(typeof(FindPersonsResultItem))]
+[AutoMap(typeof(FindPersonByLastNameAndDateOfBirthResultItem))]
 public record FindTeachersResponseResult
 {
     public required string Trn { get; init; }

diff --git a/...ngRecordSystem/src/TeachingRecordSystem.Api/V3/V20240606/Controllers/PersonsController.cs b/...ngRecordSystem/src/TeachingRecordSystem.Api/V3/V20240606/Controllers/PersonsController.cs
@@ -45,24 +45,24 @@ public async Task<IActionResult> Get(
 
     [HttpGet("")]
     [SwaggerOperation(
-        OperationId = "FindPersons",
-        Summary = "Find persons",
-        Description = "Finds persons with a TRN matching the specified criteria.")]
-    [ProducesResponseType(typeof(FindPersonsResponse), StatusCodes.Status200OK)]
+        OperationId = "FindPerson",
+        Summary = "Find person",
+        Description = "Finds a person matching the specified criteria.")]
+    [ProducesResponseType(typeof(FindPersonResponse), StatusCodes.Status200OK)]
     [ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
     [Authorize(Policy = AuthorizationPolicies.GetPerson)]
     public async Task<IActionResult> FindTeachers(
-        FindPersonsRequest request,
-        [FromServices] FindPersonsHandler handler)
+        FindPersonRequest request,
+        [FromServices] FindPersonByLastNameAndDateOfBirthHandler handler)
     {
-        var command = new FindPersonsCommand(request.LastName!, request.DateOfBirth!.Value);
+        var command = new FindPersonByLastNameAndDateOfBirthCommand(request.LastName!, request.DateOfBirth!.Value);
         var result = await handler.Handle(command);
 
-        var response = new FindPersonsResponse()
+        var response = new FindPersonResponse()
         {
             Total = result.Total,
             Query = request,
-            Results = result.Items.Select(mapper.Map<FindPersonsResponseResult>).AsReadOnly()
+            Results = result.Items.Select(mapper.Map<FindPersonResponseResult>).AsReadOnly()
         };
 
         return Ok(response);

diff --git a/.../V20240606/Requests/FindPersonsRequest.cs → ...3/V20240606/Requests/FindPersonRequest.cs b/.../V20240606/Requests/FindPersonsRequest.cs → ...3/V20240606/Requests/FindPersonRequest.cs
@@ -2,17 +2,17 @@
 
 namespace TeachingRecordSystem.Api.V3.V20240606.Requests;
 
-public record FindPersonsRequest
+public record FindPersonRequest
 {
     [FromQuery(Name = "findBy")]
-    public FindPersonsFindBy FindBy { get; init; }
+    public FindPersonFindBy FindBy { get; init; }
     [FromQuery(Name = "lastName")]
     public string? LastName { get; init; }
     [FromQuery(Name = "dateOfBirth")]
     public DateOnly? DateOfBirth { get; init; }
 }
 
-public enum FindPersonsFindBy
+public enum FindPersonFindBy
 {
     LastNameAndDateOfBirth = 1
 }
diff --git a/...ingRecordSystem/src/TeachingRecordSystem.Api/V3/V20240606/Responses/FindPersonResponse.cs b/...ingRecordSystem/src/TeachingRecordSystem.Api/V3/V20240606/Responses/FindPersonResponse.cs
@@ -0,0 +1,25 @@
+using TeachingRecordSystem.Api.V3.Core.Operations;
+using TeachingRecordSystem.Api.V3.V20240101.ApiModels;
+using TeachingRecordSystem.Api.V3.V20240606.Requests;
+
+namespace TeachingRecordSystem.Api.V3.V20240606.Responses;
+
+[AutoMap(typeof(FindPersonByLastNameAndDateOfBirthResult))]
+public record FindPersonResponse
+{
+    public required int Total { get; init; }
+    public required FindPersonRequest Query { get; init; }
+    public required IReadOnlyCollection<FindPersonResponseResult> Results { get; init; }
+}
+
+[AutoMap(typeof(FindPersonByLastNameAndDateOfBirthResultItem))]
+public record FindPersonResponseResult
+{
+    public required string Trn { get; init; }
+    public required DateOnly DateOfBirth { get; init; }
+    public required string FirstName { get; init; }
+    public required string MiddleName { get; init; }
+    public required string LastName { get; init; }
+    public required IReadOnlyCollection<SanctionInfo> Sanctions { get; init; }
+    public required IReadOnlyCollection<NameInfo> PreviousNames { get; init; }
+}
diff --git a/...stem/src/TeachingRecordSystem.Api/V3/V20240606/Validators/FindTeachersRequestValidator.cs b/...stem/src/TeachingRecordSystem.Api/V3/V20240606/Validators/FindTeachersRequestValidator.cs
@@ -3,7 +3,7 @@
 
 namespace TeachingRecordSystem.Api.V3.V20240606.Validators;
 
-public class FindTeachersRequestValidator : AbstractValidator<FindPersonsRequest>
+public class FindTeachersRequestValidator : AbstractValidator<FindPersonRequest>
 {
     public FindTeachersRequestValidator()
     {
@@ -13,12 +13,12 @@ public FindTeachersRequestValidator()
 
         RuleFor(r => r.DateOfBirth)
             .NotNull()
-            .When(r => r.FindBy == FindPersonsFindBy.LastNameAndDateOfBirth)
-            .WithMessage($"A value is required when findBy is '{nameof(FindPersonsFindBy.LastNameAndDateOfBirth)}'.");
+            .When(r => r.FindBy == FindPersonFindBy.LastNameAndDateOfBirth)
+            .WithMessage($"A value is required when findBy is '{nameof(FindPersonFindBy.LastNameAndDateOfBirth)}'.");
 
         RuleFor(r => r.LastName)
             .NotEmpty()
-            .When(r => r.FindBy == FindPersonsFindBy.LastNameAndDateOfBirth)
-            .WithMessage($"A value is required when findBy is '{nameof(FindPersonsFindBy.LastNameAndDateOfBirth)}'.");
+            .When(r => r.FindBy == FindPersonFindBy.LastNameAndDateOfBirth)
+            .WithMessage($"A value is required when findBy is '{nameof(FindPersonFindBy.LastNameAndDateOfBirth)}'.");
     }
 }
diff --git a/TeachingRecordSystem/src/TeachingRecordSystem.Api/V3/VNext/Controllers/PersonsController.cs b/TeachingRecordSystem/src/TeachingRecordSystem.Api/V3/VNext/Controllers/PersonsController.cs
@@ -5,6 +5,7 @@
 using TeachingRecordSystem.Api.V3.Core.Operations;
 using TeachingRecordSystem.Api.V3.VNext.ApiModels;
 using TeachingRecordSystem.Api.V3.VNext.Requests;
+using TeachingRecordSystem.Api.V3.VNext.Responses;
 
 namespace TeachingRecordSystem.Api.V3.VNext.Controllers;
 
@@ -13,14 +14,14 @@ public class PersonsController(IMapper mapper) : ControllerBase
 {
     [HttpPut("{trn}/qtls")]
     [SwaggerOperation(
-        OperationId = "PutQtls",
+        OperationId = "SetQtls",
         Summary = "Set QTLS status for a teacher",
         Description = "Sets the QTLS status for the teacher with the given TRN.")]
     [ProducesResponseType(typeof(QtlsInfo), StatusCodes.Status200OK)]
     [ProducesResponseType(typeof(void), StatusCodes.Status202Accepted)]
     [MapError(10001, statusCode: StatusCodes.Status404NotFound)]
     [Authorize(Policy = AuthorizationPolicies.AssignQtls)]
-    public async Task<IActionResult> Put(
+    public async Task<IActionResult> PutQtls(
         [FromRoute] string trn,
         [FromBody] SetQtlsRequest request,
         [FromServices] SetQtlsHandler handler)
@@ -37,7 +38,7 @@ public async Task<IActionResult> Put(
         Description = "Gets the QTLS status for the teacher with the given TRN.")]
     [ProducesResponseType(typeof(QtlsInfo), StatusCodes.Status200OK)]
     [Authorize(Policy = AuthorizationPolicies.AssignQtls)]
-    public async Task<IActionResult> Get(
+    public async Task<IActionResult> GetQtls(
         [FromRoute] string trn,
         [FromServices] GetQtlsHandler handler)
     {
@@ -46,4 +47,17 @@ public async Task<IActionResult> Get(
         var response = mapper.Map<QtlsInfo?>(result);
         return response is not null ? Ok(response) : NotFound();
     }
+
+    [HttpPost("find")]
+    [SwaggerOperation(
+        OperationId = "FindPersons",
+        Summary = "Find persons",
+        Description = "Finds persons matching the specified criteria.")]
+    [ProducesResponseType(typeof(FindPersonsResponse), StatusCodes.Status200OK)]
+    [ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
+    [Authorize(Policy = AuthorizationPolicies.GetPerson)]
+    public Task<IActionResult> FindTeachers([FromBody] FindPersonsRequest request)
+    {
+        throw new NotImplementedException();
+    }
 }
diff --git a/TeachingRecordSystem/src/TeachingRecordSystem.Api/V3/VNext/Requests/FindPersonsRequest.cs b/TeachingRecordSystem/src/TeachingRecordSystem.Api/V3/VNext/Requests/FindPersonsRequest.cs
@@ -0,0 +1,12 @@
+namespace TeachingRecordSystem.Api.V3.VNext.Requests;
+
+public record FindPersonsRequest
+{
+    public required IReadOnlyCollection<FindPersonsRequestPerson> Persons { get; init; }
+}
+
+public record FindPersonsRequestPerson
+{
+    public required string Trn { get; init; }
+    public required DateOnly DateOfBirth { get; init; }
+}
diff --git a/...20240606/Responses/FindPersonsResponse.cs → ...V3/VNext/Responses/FindPersonsResponse.cs b/...20240606/Responses/FindPersonsResponse.cs → ...V3/VNext/Responses/FindPersonsResponse.cs
@@ -1,18 +1,13 @@
-using TeachingRecordSystem.Api.V3.Core.Operations;
 using TeachingRecordSystem.Api.V3.V20240101.ApiModels;
-using TeachingRecordSystem.Api.V3.V20240606.Requests;
 
-namespace TeachingRecordSystem.Api.V3.V20240606.Responses;
+namespace TeachingRecordSystem.Api.V3.VNext.Responses;
 
-[AutoMap(typeof(FindPersonsResult))]
 public record FindPersonsResponse
 {
     public required int Total { get; init; }
-    public required FindPersonsRequest Query { get; init; }
     public required IReadOnlyCollection<FindPersonsResponseResult> Results { get; init; }
 }
 
-[AutoMap(typeof(FindPersonsResultItem))]
 public record FindPersonsResponseResult
 {
     public required string Trn { get; init; }

diff --git a/...i.Tests/V3/V20240606/FindTeachersTests.cs → ...indPersonByLastNameAndDateOfBirthTests.cs b/...i.Tests/V3/V20240606/FindTeachersTests.cs → ...indPersonByLastNameAndDateOfBirthTests.cs
@@ -3,9 +3,9 @@
 namespace TeachingRecordSystem.Api.Tests.V3.V20240606;
 
 [Collection(nameof(DisableParallelization))]
-public class FindTeachersTests : TestBase
+public class FindPersonByLastNameAndDateOfBirthTests : TestBase
 {
-    public FindTeachersTests(HostFixture hostFixture)
+    public FindPersonByLastNameAndDateOfBirthTests(HostFixture hostFixture)
         : base(hostFixture)
     {
         XrmFakedContext.DeleteAllEntities<Contact>();