{"openapi":"3.0.1","info":{"title":"API for GRAD Algorithm","description":"This API is for running the grad algorithm for one or more students","version":"1"},"servers":[{"url":"https://educ-grad-algorithm-api-e8a97a-dev.apps.silver.devops.gov.bc.ca","description":"Generated server url"}],"security":[{"OAUTH2":["RUN_GRAD_ALGORITHM"]}],"paths":{"/api/v2/graduatestudent":{"get":{"tags":["grad-algorithm-controller"],"operationId":"graduateStudent","parameters":[{"name":"studentID","in":"query","required":true,"schema":{"type":"string"}},{"name":"gradProgram","in":"query","required":true,"schema":{"type":"string"}},{"name":"projected","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"hypotheticalGradYear","in":"query","required":false,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GraduationData"}}}}}}},"/api/v1/metadata":{"get":{"tags":["Metadata"],"summary":"API Metadata","description":"API Metadata","operationId":"generateMetadata","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/api/v1/graduatestudent":{"get":{"tags":["grad-algorithm-controller"],"operationId":"graduateStudent_1","parameters":[{"name":"studentID","in":"query","required":true,"schema":{"type":"string"}},{"name":"gradProgram","in":"query","required":true,"schema":{"type":"string"}},{"name":"projected","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"hypotheticalGradYear","in":"query","required":false,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GraduationData"}}}}}}}},"components":{"schemas":{"ExceptionMessage":{"type":"object","properties":{"exceptionName":{"type":"string"},"exceptionDetails":{"type":"string"}}},"GradAlgorithmGraduationStudentRecord":{"type":"object","properties":{"studentGradData":{"type":"string"},"pen":{"type":"string"},"program":{"type":"string"},"programName":{"type":"string"},"programCompletionDate":{"type":"string"},"gpa":{"type":"string"},"honoursStanding":{"type":"string"},"recalculateGradStatus":{"type":"string"},"schoolOfRecord":{"type":"string"},"schoolOfRecordId":{"type":"string","format":"uuid"},"studentGrade":{"type":"string"},"studentStatus":{"type":"string"},"studentID":{"type":"string","format":"uuid"},"schoolAtGrad":{"type":"string"},"schoolAtGradId":{"type":"string","format":"uuid"},"studentCitizenship":{"type":"string"},"consumerEducationRequirementMet":{"type":"string"},"schoolAtGradName":{"type":"string"},"adultStartDate":{"type":"string","format":"date-time"}}},"GradAlgorithmOptionalStudentProgram":{"type":"object","properties":{"pen":{"type":"string"},"optionalProgramID":{"type":"string","format":"uuid"},"optionalProgramCode":{"type":"string"},"studentOptionalProgramData":{"type":"string"},"optionalProgramCompletionDate":{"type":"string"},"optionalStudentCourses":{"$ref":"#/components/schemas/StudentCourses"},"optionalStudentAssessments":{"$ref":"#/components/schemas/StudentAssessments"},"optionalNonGradReasons":{"type":"array","items":{"$ref":"#/components/schemas/GradRequirement"}},"optionalRequirementsMet":{"type":"array","items":{"$ref":"#/components/schemas/GradRequirement"}},"studentID":{"type":"string","format":"uuid"},"cpList":{"type":"array","items":{"$ref":"#/components/schemas/StudentCareerProgram"}},"optionalGraduated":{"type":"boolean"}}},"GradRequirement":{"type":"object","properties":{"transcriptRule":{"type":"string"},"description":{"type":"string"},"rule":{"type":"string"},"projected":{"type":"boolean"}}},"GradSearchStudent":{"type":"object","properties":{"studentID":{"type":"string"},"pen":{"type":"string"},"legalFirstName":{"type":"string"},"legalMiddleNames":{"type":"string"},"legalLastName":{"type":"string"},"dob":{"type":"string"},"sexCode":{"type":"string"},"genderCode":{"type":"string"},"studentCitizenship":{"type":"string"},"usualFirstName":{"type":"string"},"usualMiddleNames":{"type":"string"},"usualLastName":{"type":"string"},"email":{"type":"string"},"emailVerified":{"type":"string"},"deceasedDate":{"type":"string"},"postalCode":{"type":"string"},"mincode":{"type":"string"},"localID":{"type":"string"},"gradeCode":{"type":"string"},"gradeYear":{"type":"string"},"demogCode":{"type":"string"},"statusCode":{"type":"string"},"memo":{"type":"string"},"trueStudentID":{"type":"string"},"program":{"type":"string"},"schoolOfRecord":{"type":"string"},"schoolOfRecordId":{"type":"string"},"schoolOfRecordName":{"type":"string"},"schoolOfRecordindependentAffiliation":{"type":"string"},"studentGrade":{"type":"string"},"studentStatus":{"type":"string"}}},"GraduationData":{"type":"object","properties":{"gradStudent":{"$ref":"#/components/schemas/GradSearchStudent"},"gradStatus":{"$ref":"#/components/schemas/GradAlgorithmGraduationStudentRecord"},"optionalGradStatus":{"type":"array","items":{"$ref":"#/components/schemas/GradAlgorithmOptionalStudentProgram"}},"school":{"$ref":"#/components/schemas/School"},"studentCourses":{"$ref":"#/components/schemas/StudentCourses"},"studentAssessments":{"$ref":"#/components/schemas/StudentAssessments"},"studentExams":{"$ref":"#/components/schemas/StudentExams"},"nonGradReasons":{"type":"array","items":{"$ref":"#/components/schemas/GradRequirement"}},"requirementsMet":{"type":"array","items":{"$ref":"#/components/schemas/GradRequirement"}},"gradMessage":{"type":"string"},"dualDogwood":{"type":"boolean"},"exception":{"$ref":"#/components/schemas/ExceptionMessage"},"gradProgram":{"$ref":"#/components/schemas/GraduationProgramCode"},"latestSessionDate":{"type":"string"},"graduated":{"type":"boolean"}}},"GraduationProgramCode":{"type":"object","properties":{"programCode":{"type":"string"},"programName":{"type":"string"},"description":{"type":"string"},"displayOrder":{"type":"integer","format":"int32"},"effectiveDate":{"type":"string","format":"date-time"},"expiryDate":{"type":"string","format":"date-time"}}},"School":{"type":"object","properties":{"minCode":{"type":"string"},"schoolId":{"type":"string"},"schoolName":{"type":"string"},"districtId":{"type":"string"},"districtName":{"type":"string"},"transcriptEligibility":{"type":"string"},"certificateEligibility":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"provCode":{"type":"string"},"countryCode":{"type":"string"},"postal":{"type":"string"},"openFlag":{"type":"string"},"schoolCategoryCode":{"type":"string"},"schoolCategoryLegacyCode":{"type":"string"}}},"StudentAssessment":{"type":"object","properties":{"createUser":{"type":"string"},"updateUser":{"type":"string"},"createDate":{"type":"string"},"updateDate":{"type":"string"},"pen":{"type":"string"},"assessmentCode":{"type":"string"},"assessmentName":{"type":"string"},"sessionDate":{"type":"string"},"gradReqMet":{"type":"string"},"gradReqMetDetail":{"type":"string"},"specialCase":{"type":"string"},"exceededWriteFlag":{"type":"string"},"proficiencyScore":{"type":"number","format":"double"},"wroteFlag":{"type":"string"},"rawScore":{"type":"number","format":"double"},"percentComplete":{"type":"number","format":"double"},"irtScore":{"type":"number","format":"double"},"didNotAttemptFlag":{"type":"boolean"},"projected":{"type":"boolean"},"failed":{"type":"boolean"},"duplicate":{"type":"boolean"},"used":{"type":"boolean"},"notCompleted":{"type":"boolean"}}},"StudentAssessments":{"type":"object","properties":{"studentAssessmentList":{"type":"array","items":{"$ref":"#/components/schemas/StudentAssessment"}}}},"StudentCareerProgram":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"careerProgramCode":{"type":"string"},"careerProgramName":{"type":"string"},"studentID":{"type":"string","format":"uuid"}}},"StudentCourse":{"type":"object","properties":{"createUser":{"type":"string"},"updateUser":{"type":"string"},"createDate":{"type":"string"},"updateDate":{"type":"string"},"pen":{"type":"string"},"courseCode":{"type":"string"},"courseName":{"type":"string"},"originalCredits":{"type":"integer","format":"int32"},"courseLevel":{"type":"string"},"sessionDate":{"type":"string"},"customizedCourseName":{"type":"string"},"gradReqMet":{"type":"string"},"gradReqMetDetail":{"type":"string"},"completedCoursePercentage":{"type":"number","format":"double"},"completedCourseLetterGrade":{"type":"string"},"interimPercent":{"type":"number","format":"double"},"interimLetterGrade":{"type":"string"},"bestSchoolPercent":{"type":"number","format":"double"},"bestExamPercent":{"type":"number","format":"double"},"schoolPercent":{"type":"number","format":"double"},"examPercent":{"type":"number","format":"double"},"equivOrChallenge":{"type":"string"},"fineArtsAppliedSkills":{"type":"string"},"metLitNumRequirement":{"type":"string"},"credits":{"type":"integer","format":"int32"},"creditsUsedForGrad":{"type":"integer","format":"int32"},"relatedCourse":{"type":"string"},"relatedCourseName":{"type":"string"},"relatedLevel":{"type":"string"},"hasRelatedCourse":{"type":"string"},"genericCourseType":{"type":"string"},"language":{"type":"string"},"workExpFlag":{"type":"string"},"specialCase":{"type":"string"},"toWriteFlag":{"type":"string"},"provExamCourse":{"type":"string"},"projected":{"type":"boolean"},"failed":{"type":"boolean"},"duplicate":{"type":"boolean"},"used":{"type":"boolean"},"notCompleted":{"type":"boolean"},"careerPrep":{"type":"boolean"},"locallyDeveloped":{"type":"boolean"},"restricted":{"type":"boolean"},"boardAuthorityAuthorized":{"type":"boolean"},"independentDirectedStudies":{"type":"boolean"},"notEligibleForElective":{"type":"boolean"},"lessCreditCourse":{"type":"boolean"},"validationCourse":{"type":"boolean"},"cutOffCourse":{"type":"boolean"},"grade10Course":{"type":"boolean"}}},"StudentCourses":{"type":"object","properties":{"studentCourseList":{"type":"array","items":{"$ref":"#/components/schemas/StudentCourse"}}}},"StudentExam":{"type":"object","properties":{"pen":{"type":"string"},"courseCode":{"type":"string"},"courseName":{"type":"string"},"courseLevel":{"type":"string"},"sessionDate":{"type":"string"},"gradReqMet":{"type":"string"},"courseType":{"type":"string"},"completedCourseSchoolPercentage":{"type":"number","format":"double"},"completedCourseExamPercentage":{"type":"number","format":"double"},"completedCourseFinalPercentage":{"type":"number","format":"double"},"completedCourseLetterGrade":{"type":"string"},"interimPercent":{"type":"number","format":"double"},"interimLetterGrade":{"type":"string"},"credits":{"type":"integer","format":"int32"},"creditsUsedForGrad":{"type":"integer","format":"int32"},"reqMetLiteracyNumeracy":{"type":"string"},"wroteFlag":{"type":"string"},"specialCase":{"type":"string"}}},"StudentExams":{"type":"object","properties":{"studentExamList":{"type":"array","items":{"$ref":"#/components/schemas/StudentExam"}}}}},"securitySchemes":{"OAUTH2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://soam-dev.apps.silver.devops.gov.bc.ca/auth/realms/master/protocol/openid-connect/token"}}}}}}