#1978 - Request an Offering Change: Student View Request

sources/packages/backend/apps/api/src/app.institutions.module.ts

@@ -65,6 +65,7 @@ import {
   NoteInstitutionsController,
   RestrictionControllerService,
   ApplicationOfferingChangeRequestInstitutionsController,
+  ApplicationOfferingChangeRequestControllerService,
 } from "./route-controllers";
 import { AuthModule } from "./auth/auth.module";
 import {
@@ -162,6 +163,7 @@ import {
     ApplicationExceptionControllerService,
     StudentAppealControllerService,
     ApplicationOfferingChangeRequestService,
+    ApplicationOfferingChangeRequestControllerService,
   ],
 })
 export class AppInstitutionsModule {}

sources/packages/backend/apps/api/src/app.students.module.ts

@@ -35,6 +35,8 @@ import {
   EducationProgramStudentsController,
   StudentAccountApplicationStudentsController,
   EducationProgramOfferingStudentsController,
+  ApplicationOfferingChangeRequestStudentsController,
+  ApplicationOfferingChangeRequestControllerService,
   EducationProgramOfferingControllerService,
   RestrictionStudentsController,
   ProgramYearStudentsController,
@@ -77,6 +79,7 @@ import { ATBCIntegrationModule } from "@sims/integrations/atbc-integration";
     ATBCStudentController,
     ProgramYearStudentsController,
     OverawardStudentsController,
+    ApplicationOfferingChangeRequestStudentsController,
   ],
   providers: [
     WorkflowClientService,
@@ -117,6 +120,7 @@ import { ATBCIntegrationModule } from "@sims/integrations/atbc-integration";
     OverawardControllerService,
     StudentAppealControllerService,
     ConfirmationOfEnrollmentService,
+    ApplicationOfferingChangeRequestControllerService,
     ApplicationOfferingChangeRequestService,
   ],
 })

sources/packages/backend/apps/api/src/route-controllers/application-offering-change-request/application-offering-change-request.controller.service.ts

@@ -0,0 +1,100 @@
+import { Injectable, NotFoundException } from "@nestjs/common";
+import { ApplicationOfferingChangeRequestService } from "../../services";
+import {
+  ApplicationOfferingChangesAPIOutDTO,
+  ApplicationOfferingDetailsAPIOutDTO,
+} from "./models/application-offering-change-request.dto";
+import { getUserFullName } from "../../utilities";
+
+@Injectable()
+export class ApplicationOfferingChangeRequestControllerService {
+  constructor(
+    private readonly applicationOfferingChangeRequestService: ApplicationOfferingChangeRequestService,
+  ) {}
+
+  /**
+   * Get the Application Offering Change Request by its id for the institution.
+   * @param id the Application Offering Change Request id.
+   * @param options method options:
+   * - `locationId`: location id for institution authorization.
+   * @returns application offering change request.
+   */
+  async getById(
+    id: number,
+    options?: {
+      locationId?: number;
+    },
+  ): Promise<ApplicationOfferingChangesAPIOutDTO>;
+
+  /**
+   * Get the Application Offering Change Request by its id for the student.
+   * @param id the Application Offering Change Request id.
+   * @param options method options:
+   * - `studentId`: student id for student authorization.
+   * - `applicationOfferingDetails`: boolean true indicates that only the required application offering details for the student are requested.
+   * @returns application offering change request.
+   */
+  async getById(
+    id: number,
+    options?: {
+      studentId?: number;
+      applicationOfferingDetails?: boolean;
+    },
+  ): Promise<ApplicationOfferingDetailsAPIOutDTO>;
+
+  /**
+   * Get the Application Offering Change Request by its id.
+   * @param id the Application Offering Change Request id.
+   * @param options method options:
+   * - `studentId`: student id for student authorization.
+   * - `locationId`: location id for institution authorization.
+   * - `applicationOfferingDetails`: boolean true indicates that only the required application offering details for the student are requested.
+   * @returns application offering change request.
+   */
+  async getById(
+    id: number,
+    options?: {
+      studentId?: number;
+      locationId?: number;
+      applicationOfferingDetails?: boolean;
+    },
+  ): Promise<
+    ApplicationOfferingChangesAPIOutDTO | ApplicationOfferingDetailsAPIOutDTO
+  > {
+    const request = await this.applicationOfferingChangeRequestService.getById(
+      id,
+      { studentId: options?.studentId, locationId: options?.locationId },
+    );
+    if (!request) {
+      throw new NotFoundException(
+        "Not able to find an Application Offering Change Request.",
+      );
+    }
+    if (options?.applicationOfferingDetails) {
+      return {
+        status: request.applicationOfferingChangeRequestStatus,
+        applicationNumber: request.application.applicationNumber,
+        locationName: request.application.location.name,
+        requestedOfferingId: request.requestedOffering.id,
+        activeOfferingId: request.activeOffering.id,
+        reason: request.reason,
+      };
+    }
+    return {
+      id: request.id,
+      status: request.applicationOfferingChangeRequestStatus,
+      applicationId: request.application.id,
+      applicationNumber: request.application.applicationNumber,
+      locationName: request.application.location.name,
+      activeOfferingId: request.activeOffering.id,
+      requestedOfferingId: request.requestedOffering.id,
+      requestedOfferingDescription: request.requestedOffering.name,
+      requestedOfferingProgramId: request.requestedOffering.educationProgram.id,
+      requestedOfferingProgramName:
+        request.requestedOffering.educationProgram.name,
+      reason: request.reason,
+      assessedNoteDescription: request.assessedNote?.description,
+      studentFullName: getUserFullName(request.application.student.user),
+    };
+  }
+}

sources/packages/backend/apps/api/src/route-controllers/application-offering-change-request/application-offering-change-request.institutions.controller.ts

@@ -53,6 +53,7 @@ import {
   OFFERING_PROGRAM_YEAR_MISMATCH,
 } from "../../constants";
 import { InjectLogger, LoggerService } from "@sims/utilities/logger";
+import { ApplicationOfferingChangeRequestControllerService } from "./application-offering-change-request.controller.service";
 
 /**
  * Application offering change request controller for institutions client.
@@ -65,6 +66,7 @@ import { InjectLogger, LoggerService } from "@sims/utilities/logger";
 @HasLocationAccess("locationId")
 export class ApplicationOfferingChangeRequestInstitutionsController extends BaseController {
   constructor(
+    private readonly applicationOfferingChangeRequestControllerService: ApplicationOfferingChangeRequestControllerService,
     private readonly applicationOfferingChangeRequestService: ApplicationOfferingChangeRequestService,
     private readonly applicationService: ApplicationService,
   ) {
@@ -243,31 +245,10 @@ export class ApplicationOfferingChangeRequestInstitutionsController extends Base
     applicationOfferingChangeRequestId: number,
     @Param("locationId", ParseIntPipe) locationId: number,
   ): Promise<ApplicationOfferingChangesAPIOutDTO> {
-    const request = await this.applicationOfferingChangeRequestService.getById(
+    return this.applicationOfferingChangeRequestControllerService.getById(
       applicationOfferingChangeRequestId,
       { locationId },
     );
-    if (!request) {
-      throw new NotFoundException(
-        "Not able to find an Application Offering Change Request.",
-      );
-    }
-    return {
-      id: request.id,
-      status: request.applicationOfferingChangeRequestStatus,
-      applicationId: request.application.id,
-      applicationNumber: request.application.applicationNumber,
-      locationName: request.application.location.name,
-      activeOfferingId: request.activeOffering.id,
-      requestedOfferingId: request.requestedOffering.id,
-      requestedOfferingDescription: request.requestedOffering.name,
-      requestedOfferingProgramId: request.requestedOffering.educationProgram.id,
-      requestedOfferingProgramName:
-        request.requestedOffering.educationProgram.name,
-      reason: request.reason,
-      assessedNoteDescription: request.assessedNote?.description,
-      studentFullName: getUserFullName(request.application.student.user),
-    };
   }
 
   /**

sources/packages/backend/apps/api/src/route-controllers/application-offering-change-request/application-offering-change-request.students.controller.ts

@@ -0,0 +1,136 @@
+import {
+  Body,
+  Controller,
+  Get,
+  NotFoundException,
+  Param,
+  ParseIntPipe,
+  Patch,
+  UnauthorizedException,
+} from "@nestjs/common";
+import {
+  ApiNotFoundResponse,
+  ApiTags,
+  ApiUnauthorizedResponse,
+} from "@nestjs/swagger";
+import { AuthorizedParties } from "../../auth/authorized-parties.enum";
+import { AllowAuthorizedParty, UserToken } from "../../auth/decorators";
+import { ClientTypeBaseRoute } from "../../types";
+import BaseController from "../BaseController";
+import {
+  ApplicationOfferingChangeRequestStatusAPIOutDTO,
+  ApplicationOfferingDetailsAPIOutDTO,
+  StudentApplicationOfferingChangeRequestAPIInDTO,
+} from "./models/application-offering-change-request.dto";
+import { StudentUserToken } from "../../auth";
+import { ApplicationOfferingChangeRequestControllerService } from "./application-offering-change-request.controller.service";
+import { ApplicationOfferingChangeRequestService } from "../../services";
+
+/**
+ * Application offering change request controller for students client.
+ */
+@AllowAuthorizedParty(AuthorizedParties.student)
+@Controller("application-offering-change-request")
+@ApiTags(`${ClientTypeBaseRoute.Student}-application-offering-change-request`)
+export class ApplicationOfferingChangeRequestStudentsController extends BaseController {
+  constructor(
+    private readonly applicationOfferingChangeRequestService: ApplicationOfferingChangeRequestService,
+    private readonly applicationOfferingChangeRequestControllerService: ApplicationOfferingChangeRequestControllerService,
+  ) {
+    super();
+  }
+
+  /**
+   * Gets the Application Offering Change Request details.
+   * @param applicationOfferingChangeRequestId the Application Offering Change Request id.
+   * @param studentUserToken student user token to authorize the user.
+   * @returns Application Offering Change Request details.
+   */
+  @Get(":applicationOfferingChangeRequestId")
+  @ApiNotFoundResponse({
+    description: "Not able to find an Application Offering Change Request.",
+  })
+  async getById(
+    @Param("applicationOfferingChangeRequestId", ParseIntPipe)
+    applicationOfferingChangeRequestId: number,
+    @UserToken()
+    studentUserToken: StudentUserToken,
+  ): Promise<ApplicationOfferingDetailsAPIOutDTO> {
+    return this.applicationOfferingChangeRequestControllerService.getById(
+      applicationOfferingChangeRequestId,
+      {
+        studentId: studentUserToken.studentId,
+        applicationOfferingDetails: true,
+      },
+    );
+  }
+
+  /**
+   * Gets the Application Offering Change Request status.
+   * @param applicationOfferingChangeRequestId the Application Offering Change Request id.
+   * @param studentUserToken student user token to authorize the user.
+   * @returns Application Offering Change Request status.
+   */
+  @Get(
+    ":applicationOfferingChangeRequestId/application-offering-change-request-status",
+  )
+  @ApiNotFoundResponse({
+    description:
+      "Not able to get the Application Offering Change Request Status.",
+  })
+  async getApplicationOfferingChangeRequestStatusById(
+    @Param("applicationOfferingChangeRequestId", ParseIntPipe)
+    applicationOfferingChangeRequestId: number,
+    @UserToken()
+    studentUserToken: StudentUserToken,
+  ): Promise<ApplicationOfferingChangeRequestStatusAPIOutDTO> {
+    const applicationOfferingChangeRequestStatus =
+      await this.applicationOfferingChangeRequestService.getApplicationOfferingChangeRequestStatusById(
+        applicationOfferingChangeRequestId,
+        {
+          studentId: studentUserToken.studentId,
+        },
+      );
+    if (!applicationOfferingChangeRequestStatus) {
+      throw new NotFoundException(
+        "Not able to get the Application Offering Change Request Status.",
+      );
+    }
+    return { status: applicationOfferingChangeRequestStatus };
+  }
+
+  /**
+   * Updates an application offering change request status.
+   * @param applicationOfferingChangeRequestId application offering change request id.
+   * @param userToken user token to authorize the user.
+   * @param payload information to update the application offering change request status.
+   */
+  @Patch(":applicationOfferingChangeRequestId")
+  @ApiUnauthorizedResponse({
+    description:
+      "The student does not have access to the application offering change request.",
+  })
+  async updateApplicationOfferingChangeRequestStatus(
+    @Param("applicationOfferingChangeRequestId", ParseIntPipe)
+    applicationOfferingChangeRequestId: number,
+    @UserToken()
+    userToken: StudentUserToken,
+    @Body()
+    payload: StudentApplicationOfferingChangeRequestAPIInDTO,
+  ): Promise<void> {
+    const studentAuthorized =
+      await this.applicationOfferingChangeRequestService.getById(
+        applicationOfferingChangeRequestId,
+        { studentId: userToken.studentId },
+      );
+    if (!studentAuthorized) {
+      throw new UnauthorizedException(
+        "Student is not authorized for the provided offering.",
+      );
+    }
+    await this.applicationOfferingChangeRequestService.updateApplicationOfferingChangeRequestStatus(
+      applicationOfferingChangeRequestId,
+      payload,
+    );
+  }
+}

sources/packages/backend/apps/api/src/route-controllers/application-offering-change-request/models/application-offering-change-request.dto.ts

@@ -4,11 +4,14 @@ import {
   REASON_MAX_LENGTH,
 } from "@sims/sims-db";
 import {
+  IsBoolean,
+  IsEnum,
   IsIn,
   IsNotEmpty,
   IsOptional,
   IsPositive,
   MaxLength,
+  ValidateIf,
 } from "class-validator";
 import { PaginationOptionsAPIInDTO } from "../../models/pagination.dto";
 
@@ -106,6 +109,22 @@ export class ApplicationOfferingChangesAPIOutDTO {
   studentFullName: string;
 }
 
+export interface ApplicationOfferingDetailsAPIOutDTO {
+  applicationNumber: string;
+  locationName: string;
+  status: ApplicationOfferingChangeRequestStatus;
+  requestedOfferingId: number;
+  activeOfferingId: number;
+  reason: string;
+}
+
+/**
+ * Application Offering Change Request Status.
+ */
+export class ApplicationOfferingChangeRequestStatusAPIOutDTO {
+  status: ApplicationOfferingChangeRequestStatus;
+}
+
 /**
  * Information provided by the institution to create a new Application Offering Change Request.
  */
@@ -119,6 +138,22 @@ export class CreateApplicationOfferingChangeRequestAPIInDTO {
   reason: string;
 }
 
+/**
+ * Details to update the application offering change request by student.
+ */
+export class StudentApplicationOfferingChangeRequestAPIInDTO {
+  @IsOptional()
+  @IsBoolean()
+  @ValidateIf(
+    (value: StudentApplicationOfferingChangeRequestAPIInDTO) =>
+      value.applicationOfferingChangeRequestStatus ===
+      ApplicationOfferingChangeRequestStatus.InProgressWithSABC,
+  )
+  studentConsent: boolean;
+  @IsEnum(ApplicationOfferingChangeRequestStatus)
+  applicationOfferingChangeRequestStatus: ApplicationOfferingChangeRequestStatus;
+}
+
 /**
  * All in progress application offering change details.
  */

sources/packages/backend/apps/api/src/route-controllers/application-offering-change-request/models/application-offering-change-request.models.ts

@@ -0,0 +1,6 @@
+import { ApplicationOfferingChangeRequestStatus } from "@sims/sims-db";
+
+export interface StudentApplicationOfferingChangeRequest {
+  studentConsent: boolean;
+  applicationOfferingChangeRequestStatus: ApplicationOfferingChangeRequestStatus;
+}