{"openapi":"3.0.1","info":{"title":"API for Student Profile Email.","description":"This API is responsible for sending different type of email notification to students, schools or Helpdesk.","version":"1"},"servers":[{"url":"https://student-profile-email-api-8878b4-dev.apps.silver.devops.gov.bc.ca","description":"Generated server url"}],"security":[{"OAUTH2":["SEND_STUDENT_PROFILE_EMAIL"]}],"paths":{"/ump/verify":{"post":{"tags":["Update My Pen Email"],"description":"verify student email","operationId":"verifyEmail","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UMPRequestEmailVerificationEntity"}}},"required":true},"responses":{"204":{"description":"NO CONTENT"},"500":{"description":"INTERNAL SERVER ERROR."}}}},"/ump/reject":{"post":{"tags":["Update My Pen Email"],"description":"send reject notification email","operationId":"sendRejectedRequestEmail","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UMPRequestRejectedEmailEntity"}}},"required":true},"responses":{"204":{"description":"NO CONTENT"},"500":{"description":"INTERNAL SERVER ERROR."}}}},"/ump/notify-stale-return":{"post":{"tags":["Update My Pen Email"],"description":"send additional info request email","operationId":"notifyStudentForStaleReturnedRequests","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UMPAdditionalInfoEmailEntity"}}},"required":true},"responses":{"204":{"description":"NO CONTENT"},"500":{"description":"INTERNAL SERVER ERROR."}}}},"/ump/info":{"post":{"tags":["Update My Pen Email"],"description":"send additional info request email","operationId":"sendAdditionalInfoRequestEmail","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UMPAdditionalInfoEmailEntity"}}},"required":true},"responses":{"204":{"description":"NO CONTENT"},"500":{"description":"INTERNAL SERVER ERROR."}}}},"/ump/complete":{"post":{"tags":["Update My Pen Email"],"description":"send complete email","operationId":"sendCompletedRequestEmail","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UMPRequestCompleteEmailEntity"}}},"required":true},"responses":{"204":{"description":"NO CONTENT"},"500":{"description":"INTERNAL SERVER ERROR."}}}},"/gmp/verify":{"post":{"tags":["Get My Pen Email"],"description":"verify student email","operationId":"verifyEmail_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GMPRequestEmailVerificationEntity"}}},"required":true},"responses":{"204":{"description":"NO CONTENT"},"500":{"description":"INTERNAL SERVER ERROR."}}}},"/gmp/reject":{"post":{"tags":["Get My Pen Email"],"description":"send reject notification email","operationId":"sendRejectedPENRequestEmail","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GMPRequestRejectedEmailEntity"}}},"required":true},"responses":{"204":{"description":"NO CONTENT"},"500":{"description":"INTERNAL SERVER ERROR."}}}},"/gmp/notify-stale-return":{"post":{"tags":["Get My Pen Email"],"description":"notifies student that their request is in return state for a long time and they have to action it.","operationId":"notifyStudentForStaleReturnedRequests_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GMPRequestAdditionalInfoEmailEntity"}}},"required":true},"responses":{"204":{"description":"NO CONTENT"},"500":{"description":"INTERNAL SERVER ERROR."}}}},"/gmp/info":{"post":{"tags":["Get My Pen Email"],"description":"send additional info request email","operationId":"sendAdditionalInfoRequestEmail_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GMPRequestAdditionalInfoEmailEntity"}}},"required":true},"responses":{"204":{"description":"NO CONTENT"},"500":{"description":"INTERNAL SERVER ERROR."}}}},"/gmp/complete":{"post":{"tags":["Get My Pen Email"],"description":"send complete email","operationId":"sendCompletedPENRequestEmail","parameters":[{"name":"demographicsChanged","in":"query","required":true,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GMPRequestCompleteEmailEntity"}}},"required":true},"responses":{"204":{"description":"NO CONTENT"},"500":{"description":"INTERNAL SERVER ERROR."}}}},"/api/v2/send-email":{"post":{"tags":["Email Notification"],"description":"send email","operationId":"sendEmail","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailNotificationEntity"}}},"required":true},"responses":{"204":{"description":"NO CONTENT"},"500":{"description":"INTERNAL SERVER ERROR."}}}}},"components":{"schemas":{"UMPRequestEmailVerificationEntity":{"required":["emailAddress","identityTypeLabel","jwtToken","studentRequestId","verificationUrl"],"type":"object","properties":{"emailAddress":{"type":"string"},"identityType":{"type":"string"},"studentRequestId":{"type":"string"},"identityTypeLabel":{"type":"string"},"verificationUrl":{"type":"string"},"jwtToken":{"type":"string"}}},"UMPRequestRejectedEmailEntity":{"required":["emailAddress","rejectionReason"],"type":"object","properties":{"emailAddress":{"type":"string"},"identityType":{"type":"string"},"rejectionReason":{"type":"string"}}},"UMPAdditionalInfoEmailEntity":{"required":["emailAddress"],"type":"object","properties":{"emailAddress":{"type":"string"},"identityType":{"type":"string"}}},"UMPRequestCompleteEmailEntity":{"required":["emailAddress"],"type":"object","properties":{"emailAddress":{"type":"string"},"identityType":{"type":"string"},"firstName":{"type":"string"}}},"GMPRequestEmailVerificationEntity":{"required":["emailAddress","identityTypeLabel","jwtToken","penRequestId","verificationUrl"],"type":"object","properties":{"emailAddress":{"type":"string"},"identityType":{"type":"string"},"penRequestId":{"type":"string"},"identityTypeLabel":{"type":"string"},"verificationUrl":{"type":"string"},"jwtToken":{"type":"string"}}},"GMPRequestRejectedEmailEntity":{"required":["emailAddress","rejectionReason"],"type":"object","properties":{"emailAddress":{"type":"string"},"identityType":{"type":"string"},"rejectionReason":{"type":"string"}}},"GMPRequestAdditionalInfoEmailEntity":{"required":["emailAddress"],"type":"object","properties":{"emailAddress":{"type":"string"},"identityType":{"type":"string"}}},"GMPRequestCompleteEmailEntity":{"required":["emailAddress"],"type":"object","properties":{"emailAddress":{"type":"string"},"identityType":{"type":"string"},"firstName":{"type":"string"},"demographicsChanged":{"type":"boolean"}}},"EmailNotificationEntity":{"required":["emailFields","fromEmail","subject","templateName","toEmail"],"type":"object","properties":{"fromEmail":{"type":"string"},"toEmail":{"type":"array","items":{"type":"string"}},"subject":{"type":"string"},"templateName":{"type":"string"},"emailFields":{"type":"object","additionalProperties":{"type":"string"}}}}}}}