[SELC-7869] feat: Added new endpoint to retrive onboardingId from taxCode and status

giampiero-ferrara · web-flow · commit 5f69ba5602de · 2025-10-23T16:34:50.000+02:00
diff --git a/app/src/main/resources/swagger/api-docs.json b/app/src/main/resources/swagger/api-docs.json
@@ -2263,6 +2263,91 @@
         } ]
       }
     },
+    "/v2/institutions/onboardings" : {
+      "get" : {
+        "tags" : [ "institution-v-2-controller" ],
+        "summary" : "Retrieve onboarding information for an institution filtered by tax code and status",
+        "description" : "Returns a list of onboarding processes associated with the institution identified by the provided tax code. The results can be filtered by the onboarding status. Each item in the response contains key details such as the onboarding ID, related product, and current status.",
+        "operationId" : "getOnboardingInfo",
+        "parameters" : [ {
+          "name" : "taxCode",
+          "in" : "query",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "name" : "status",
+          "in" : "query",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "description" : "OK",
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "type" : "array",
+                  "items" : {
+                    "$ref" : "#/components/schemas/OnboardingResult"
+                  }
+                }
+              }
+            }
+          },
+          "400" : {
+            "description" : "Bad Request",
+            "content" : {
+              "application/problem+json" : {
+                "schema" : {
+                  "type" : "object",
+                  "description" : "Generic problem response"
+                }
+              }
+            }
+          },
+          "401" : {
+            "description" : "Unauthorized",
+            "content" : {
+              "application/problem+json" : {
+                "schema" : {
+                  "type" : "object",
+                  "description" : "Generic problem response"
+                }
+              }
+            }
+          },
+          "404" : {
+            "description" : "Not Found",
+            "content" : {
+              "application/problem+json" : {
+                "schema" : {
+                  "type" : "object",
+                  "description" : "Generic problem response"
+                }
+              }
+            }
+          },
+          "500" : {
+            "description" : "Internal Server Error",
+            "content" : {
+              "application/problem+json" : {
+                "schema" : {
+                  "type" : "object",
+                  "description" : "Generic problem response"
+                }
+              }
+            }
+          }
+        },
+        "security" : [ {
+          "bearerAuth" : [ "global" ]
+        } ]
+      }
+    },
     "/v2/institutions/onboarding/recipient-code/verification" : {
       "get" : {
         "tags" : [ "institution-v-2-controller" ],
@@ -4241,6 +4326,20 @@
           }
         }
       },
+      "OnboardingResult" : {
+        "type" : "object",
+        "properties" : {
+          "id" : {
+            "type" : "string"
+          },
+          "status" : {
+            "type" : "string"
+          },
+          "productId" : {
+            "type" : "string"
+          }
+        }
+      },
       "Billing" : {
         "type" : "object",
         "properties" : {
diff --git a/connector-api/src/main/java/it/pagopa/selfcare/onboarding/connector/api/OnboardingMsConnector.java b/connector-api/src/main/java/it/pagopa/selfcare/onboarding/connector/api/OnboardingMsConnector.java
@@ -1,5 +1,6 @@
 package it.pagopa.selfcare.onboarding.connector.api;
 
+import it.pagopa.selfcare.onboarding.connector.model.OnboardingResult;
 import it.pagopa.selfcare.onboarding.connector.model.RecipientCodeStatusResult;
 import it.pagopa.selfcare.onboarding.connector.model.institutions.VerifyAggregateResult;
 import it.pagopa.selfcare.onboarding.connector.model.onboarding.CheckManagerData;
@@ -53,4 +54,5 @@ public interface OnboardingMsConnector {
 
     void onboardingUsersPgFromIcAndAde(OnboardingData onboardingUserPgRequest);
 
+    List<OnboardingResult> onboardingWithFilter(String taxCode, String status);
 }
diff --git a/connector-api/src/main/java/it/pagopa/selfcare/onboarding/connector/model/OnboardingResult.java b/connector-api/src/main/java/it/pagopa/selfcare/onboarding/connector/model/OnboardingResult.java
@@ -0,0 +1,10 @@
+package it.pagopa.selfcare.onboarding.connector.model;
+
+import lombok.Data;
+
+@Data
+public class OnboardingResult {
+    String id;
+    String status;
+    String productId;
+}
diff --git a/connector/rest/src/main/java/it/pagopa/selfcare/onboarding/connector/OnboardingMsConnectorImpl.java b/connector/rest/src/main/java/it/pagopa/selfcare/onboarding/connector/OnboardingMsConnectorImpl.java
@@ -5,19 +5,18 @@
 import it.pagopa.selfcare.onboarding.common.InstitutionType;
 import it.pagopa.selfcare.onboarding.connector.api.OnboardingMsConnector;
 import it.pagopa.selfcare.onboarding.connector.exceptions.InvalidRequestException;
+import it.pagopa.selfcare.onboarding.connector.model.OnboardingResult;
 import it.pagopa.selfcare.onboarding.connector.model.RecipientCodeStatusResult;
 import it.pagopa.selfcare.onboarding.connector.model.institutions.VerifyAggregateResult;
 import it.pagopa.selfcare.onboarding.connector.model.onboarding.CheckManagerData;
 import it.pagopa.selfcare.onboarding.connector.model.onboarding.OnboardingData;
 import it.pagopa.selfcare.onboarding.connector.rest.client.*;
 import it.pagopa.selfcare.onboarding.connector.rest.mapper.OnboardingMapper;
-import it.pagopa.selfcare.onboarding.generated.openapi.v1.dto.OnboardingGet;
-import it.pagopa.selfcare.onboarding.generated.openapi.v1.dto.OnboardingResponse;
-import it.pagopa.selfcare.onboarding.generated.openapi.v1.dto.OnboardingStatus;
-import it.pagopa.selfcare.onboarding.generated.openapi.v1.dto.ReasonRequest;
+import it.pagopa.selfcare.onboarding.generated.openapi.v1.dto.*;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.core.io.Resource;
 import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
 import org.springframework.stereotype.Service;
 import org.springframework.util.Assert;
 import org.springframework.util.StringUtils;
@@ -219,4 +218,26 @@ public void onboardingUsersPgFromIcAndAde(OnboardingData onboardingData) {
         msOnboardingApiClient._onboardingUsersPg(onboardingMapper.toOnboardingUserPgRequest(onboardingData));
         log.trace("onboardingUsersPgFromIcAndAde end");
     }
+
+    @Override
+    public List<OnboardingResult> onboardingWithFilter(String taxCode, String status) {
+        log.trace("onboardingWithFilter start");
+        ResponseEntity<OnboardingGetResponse> response = msOnboardingApiClient._getOnboardingWithFilter( null,
+                null,
+                null,
+                null,
+                null,
+                null,
+                null,
+                null,
+                status,
+                null,
+                taxCode,
+                null,
+                null);
+        List<OnboardingResult> onboardingResults = onboardingMapper.toOnboardingWithFilter(response.getBody());
+        log.trace("onboardingWithFilter end");
+        return onboardingResults;
+    }
+
 }
diff --git a/connector/rest/src/main/java/it/pagopa/selfcare/onboarding/connector/rest/mapper/OnboardingMapper.java b/connector/rest/src/main/java/it/pagopa/selfcare/onboarding/connector/rest/mapper/OnboardingMapper.java
@@ -1,6 +1,7 @@
 package it.pagopa.selfcare.onboarding.connector.rest.mapper;
 
 
+import it.pagopa.selfcare.onboarding.connector.model.OnboardingResult;
 import it.pagopa.selfcare.onboarding.connector.model.RecipientCodeStatusResult;
 import it.pagopa.selfcare.onboarding.connector.model.institutions.VerifyAggregateResult;
 import it.pagopa.selfcare.onboarding.connector.model.onboarding.*;
@@ -10,6 +11,7 @@
 import org.mapstruct.Mapping;
 import org.mapstruct.Named;
 
+import java.util.List;
 import java.util.Objects;
 import java.util.Optional;
 
@@ -142,4 +144,21 @@ default String setOrigin(Origin origin) {
     RecipientCodeStatusResult toRecipientCodeStatusResult(RecipientCodeStatus recipientCodeStatus);
 
     OnboardingUserPgRequest toOnboardingUserPgRequest(OnboardingData onboardingData);
+
+   default List<OnboardingResult> toOnboardingWithFilter(OnboardingGetResponse onboardingGetResponse) {
+        if (onboardingGetResponse == null || onboardingGetResponse.getItems() == null) {
+            return List.of();
+        }
+
+        return onboardingGetResponse.getItems().stream()
+                .filter(Objects::nonNull)
+                .map(current -> {
+                    OnboardingResult onboarding = new OnboardingResult();
+                    onboarding.setId(current.getId());
+                    onboarding.setProductId(current.getProductId());
+                    onboarding.setStatus(current.getStatus());
+                    return onboarding;
+                })
+                .toList();
+    }
 }
diff --git a/connector/rest/src/test/java/it/pagopa/selfcare/onboarding/connector/OnboardingMsConnectorImplTest.java b/connector/rest/src/test/java/it/pagopa/selfcare/onboarding/connector/OnboardingMsConnectorImplTest.java
@@ -2,6 +2,7 @@
 
 import it.pagopa.selfcare.onboarding.common.InstitutionType;
 import it.pagopa.selfcare.onboarding.connector.exceptions.InvalidRequestException;
+import it.pagopa.selfcare.onboarding.connector.model.OnboardingResult;
 import it.pagopa.selfcare.onboarding.connector.model.RecipientCodeStatusResult;
 import it.pagopa.selfcare.onboarding.connector.model.institutions.Institution;
 import it.pagopa.selfcare.onboarding.connector.model.institutions.VerifyAggregateResult;
@@ -649,4 +650,61 @@ void verifyOnboardingSubunitCode() {
                 ._verifyOnboardingInfoByFilters(InstitutionType.PA.name(), origin, originId, productId, subunitCode, taxCode);
         verifyNoMoreInteractions(msOnboardingApiClient);
     }
+
+    @Test
+    void onboardingWithFilterTest() {
+        // Given
+        final String taxCode = "taxCode";
+        final String status = "status";
+
+        OnboardingGet onboardingGet = new OnboardingGet();
+        onboardingGet.setProductId("prod-test");
+        List<OnboardingGet> onboardingGets = List.of(onboardingGet);
+
+        OnboardingGetResponse onboardingGetResponse = new OnboardingGetResponse();
+        onboardingGetResponse.setItems(onboardingGets);
+        ResponseEntity<OnboardingGetResponse> responseEntity = ResponseEntity.ok(onboardingGetResponse);
+
+        when(msOnboardingApiClient._getOnboardingWithFilter( any(),
+                any(),
+                any(),
+                any(),
+                any(),
+                any(),
+                any(),
+                any(),
+                any(),
+                any(),
+                any(),
+                any(),
+                any())).thenReturn(responseEntity);
+
+        OnboardingResult onboardingResult = new OnboardingResult();
+        onboardingResult.setProductId("product-test");
+        when(onboardingMapper.toOnboardingWithFilter(responseEntity.getBody()))
+                .thenReturn(List.of(onboardingResult));
+
+        // When
+        onboardingMsConnector.onboardingWithFilter(taxCode, status);
+
+        // Then
+        verify(msOnboardingApiClient, times(1))
+                ._getOnboardingWithFilter( any(),
+                        any(),
+                        any(),
+                        any(),
+                        any(),
+                        any(),
+                        any(),
+                        any(),
+                        any(),
+                        any(),
+                        any(),
+                        any(),
+                        any());
+        verify(onboardingMapper, times(1))
+                .toOnboardingWithFilter(responseEntity.getBody());
+        verifyNoMoreInteractions(msOnboardingApiClient);
+        verifyNoMoreInteractions(onboardingMapper);
+    }
 }
diff --git a/core/src/main/java/it/pagopa/selfcare/onboarding/core/InstitutionService.java b/core/src/main/java/it/pagopa/selfcare/onboarding/core/InstitutionService.java
@@ -2,6 +2,7 @@
 
 import it.pagopa.selfcare.onboarding.connector.model.InstitutionLegalAddressData;
 import it.pagopa.selfcare.onboarding.connector.model.InstitutionOnboardingData;
+import it.pagopa.selfcare.onboarding.connector.model.OnboardingResult;
 import it.pagopa.selfcare.onboarding.connector.model.RecipientCodeStatusResult;
 import it.pagopa.selfcare.onboarding.connector.model.institutions.*;
 import it.pagopa.selfcare.onboarding.connector.model.institutions.infocamere.InstitutionInfoIC;
@@ -55,4 +56,6 @@ public interface InstitutionService {
     void onboardingUsersPgFromIcAndAde(OnboardingData onboardingUserPgRequest);
 
     ManagerVerification verifyManager(String taxCode, String companyTaxCode);
+
+    List<OnboardingResult> getOnboardingWithFilter(String taxCode, String status);
 }
diff --git a/core/src/main/java/it/pagopa/selfcare/onboarding/core/InstitutionServiceImpl.java b/core/src/main/java/it/pagopa/selfcare/onboarding/core/InstitutionServiceImpl.java
@@ -1,19 +1,13 @@
 package it.pagopa.selfcare.onboarding.core;
 
-import static io.netty.util.internal.StringUtil.isNullOrEmpty;
-import static it.pagopa.selfcare.onboarding.connector.model.user.User.Fields.*;
-
 import it.pagopa.selfcare.commons.base.logging.LogUtils;
 import it.pagopa.selfcare.commons.base.utils.Origin;
 import it.pagopa.selfcare.onboarding.common.InstitutionType;
 import it.pagopa.selfcare.onboarding.common.PartyRole;
 import it.pagopa.selfcare.onboarding.connector.api.*;
 import it.pagopa.selfcare.onboarding.connector.exceptions.InvalidRequestException;
 import it.pagopa.selfcare.onboarding.connector.exceptions.ResourceNotFoundException;
-import it.pagopa.selfcare.onboarding.connector.model.InstitutionLegalAddressData;
-import it.pagopa.selfcare.onboarding.connector.model.InstitutionOnboardingData;
-import it.pagopa.selfcare.onboarding.connector.model.RecipientCodeStatusResult;
-import it.pagopa.selfcare.onboarding.connector.model.RelationshipState;
+import it.pagopa.selfcare.onboarding.connector.model.*;
 import it.pagopa.selfcare.onboarding.connector.model.institutions.*;
 import it.pagopa.selfcare.onboarding.connector.model.institutions.infocamere.BusinessInfoIC;
 import it.pagopa.selfcare.onboarding.connector.model.institutions.infocamere.InstitutionInfoIC;
@@ -36,7 +30,6 @@
 import it.pagopa.selfcare.product.entity.ProductStatus;
 import it.pagopa.selfcare.product.exception.ProductNotFoundException;
 import it.pagopa.selfcare.product.service.ProductService;
-import java.util.*;
 import jakarta.validation.ValidationException;
 import lombok.extern.slf4j.Slf4j;
 import org.owasp.encoder.Encode;
@@ -46,6 +39,11 @@
 import org.springframework.util.CollectionUtils;
 import org.springframework.web.multipart.MultipartFile;
 
+import java.util.*;
+
+import static io.netty.util.internal.StringUtil.isNullOrEmpty;
+import static it.pagopa.selfcare.onboarding.connector.model.user.User.Fields.*;
+
 @Slf4j
 @Service
 class InstitutionServiceImpl implements InstitutionService {
@@ -718,4 +716,14 @@ private void setLocationInfo(InstitutionInfo institutionInfo){
         }
     }
 
+    public List<OnboardingResult> getOnboardingWithFilter(String inputTaxCode, String inputStatus) {
+        log.trace("getOnboardingWithFilter start");
+        String taxCode = Encode.forJava(inputTaxCode);
+        String status = Encode.forJava(inputStatus);
+        log.debug("getOnboardingWithFilter with taxCode = {}, stauts = {}", taxCode, status);
+        List<OnboardingResult> result =  onboardingMsConnector.onboardingWithFilter(taxCode, status);
+        log.trace("getOnboardingWithFilter end");
+        return result;
+    }
+
 }
diff --git a/core/src/test/java/it/pagopa/selfcare/onboarding/core/InstitutionServiceImplTest.java b/core/src/test/java/it/pagopa/selfcare/onboarding/core/InstitutionServiceImplTest.java
diff --git a/web/src/main/java/it/pagopa/selfcare/onboarding/web/controller/InstitutionV2Controller.java b/web/src/main/java/it/pagopa/selfcare/onboarding/web/controller/InstitutionV2Controller.java
diff --git a/web/src/main/resources/swagger/swagger_en.properties b/web/src/main/resources/swagger/swagger_en.properties
diff --git a/web/src/test/java/it/pagopa/selfcare/onboarding/web/controller/InstitutionV2ControllerTest.java b/web/src/test/java/it/pagopa/selfcare/onboarding/web/controller/InstitutionV2ControllerTest.java

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`package it.pagopa.selfcare.onboarding.connector.api;`
`2`	`2`
	`3`	`+import it.pagopa.selfcare.onboarding.connector.model.OnboardingResult;`
`3`	`4`	`import it.pagopa.selfcare.onboarding.connector.model.RecipientCodeStatusResult;`
`4`	`5`	`import it.pagopa.selfcare.onboarding.connector.model.institutions.VerifyAggregateResult;`
`5`	`6`	`import it.pagopa.selfcare.onboarding.connector.model.onboarding.CheckManagerData;`
`@@ -53,4 +54,5 @@ public interface OnboardingMsConnector {`
`53`	`54`
`54`	`55`	`void onboardingUsersPgFromIcAndAde(OnboardingData onboardingUserPgRequest);`
`55`	`56`
	`57`	`+ List<OnboardingResult> onboardingWithFilter(String taxCode, String status);`
`56`	`58`	`}`