Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance /api/administration/registration/applications Endpoint #842

Open
jjeroch opened this issue Jul 17, 2024 · 0 comments
Open

Enhance /api/administration/registration/applications Endpoint #842

jjeroch opened this issue Jul 17, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@jjeroch
Copy link
Contributor

jjeroch commented Jul 17, 2024

Description:
Enhance the /api/administration/registration/applications?size=10&page=0 endpoint by adding a new attribute "type" to the response, which indicates whether the application is "external" or "internal". This information is available at the application level in the database.

Acceptance Criteria:

  1. Endpoint Enhancement:

    • Modify the existing endpoint to include the "type" attribute in the response.
    • The "type" attribute should have a unique value, either "external" or "internal", based on the information stored in the database.
  2. Database Integration:

    • Retrieve the "type" information from the application-level data in the database.
    • Ensure the "type" attribute is properly mapped and included in the endpoint response.
  3. Response Structure:

    • Update the existing response structure to include the new "type" attribute for each application in the "content" array.
    • The updated response structure should be as follows:
{
  "meta": {
    "totalElements": 0,
    "totalPages": 0,
    "page": 0,
    "contentSize": 0
  },
  "content": [
    {
      "applicationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "applicationStatus": "CREATED",
      "dateCreated": "2024-07-17T11:33:13.790Z",
      "companyName": "string",
      "companyRoles": [
        "ACTIVE_PARTICIPANT"
      ],
      "applicationChecklist": [
        {
          "typeId": "REGISTRATION_VERIFICATION",
          "statusId": "TO_DO"
        }
      ],
      "email": "string",
      "bpn": "string",
      "type": "external"
    }
  ]
}
  1. Error Handling:

    • Instead of submitting an error in case no type is existing, the endpoint is supposed to respond for the type the value null
  2. Documentation:

    • Update the API documentation to reflect the changes made to the endpoint, including the new "type" attribute.
  3. Testing:

    • Implement unit tests to ensure the endpoint's functionality, including the new "type" attribute, works as expected
@jjeroch jjeroch added the enhancement New feature or request label Jul 17, 2024
@jjeroch jjeroch added this to the Release 24.12 milestone Jul 17, 2024
Phil91 pushed a commit that referenced this issue Aug 8, 2024
Reviewed-By: Phil Schneider <info@philschneider.de>
Refs: #842
@evegufy evegufy modified the milestones: Release 24.12, Release 2.2.0 Aug 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: USER READY
Development

No branches or pull requests

3 participants