AER Field Requirements

Owned by Erin McGarrahan (Deactivated)
Last updated: Oct 27, 2020 by Justin Schultz
4 min read

REQUIREMENTS FINALIZED AND UPDATED AS OF 8.25.2020

 

AER Fields To Be Passed in AER Record

The following fields are needed to create the AER electronically.

Field Name

Required/Optional

Origin

Editable Y/N

CCC-ID

Required Field

SSO Proxy

NOTE: If the home college IDP is configured to send the CCCID, the CCCID will just be passed through the proxy (but it originates at the home college IDP). If the home college is not configured to send the cccid, or the student does not have a cccid, the proxy will send the student to OpenCCC to create or recover the cccid. In this case, the cccid is coming from the proxy.

N

First Name

Required Field

SSO Proxy or /contactInfo API

N

Middle Name

Optional Field

Student self-reported or /contactInfo API

  • Middle name will never come through the proxy. User should have the ability to enter middle name in AER form if they choose.

  • If middle name is passed from the SIS, it should pre-populate in the AER form and user should not have the ability to edit it.

  • If middle name does not come through the SIS, use should have the ability to enter it if they choose in the AER form.

Last Name

Required Field

SSO Proxy or /contactInfo API

N

Home College MIS Code

Required Field

SSO Proxy

N

address-streetline1

Required Field

Student self-reported

Y - Even though the Contact Info API is set up to populate the address, a business decision was made to not populate it in any scenario: https://cvc-oei.atlassian.net/browse/BLQ-159

address-streetline2

Optional Field

Student self-reported

Y - Even though the Contact Info API is set up to populate the address, a business decision was made to not populate it in any scenario: https://cvc-oei.atlassian.net/browse/BLQ-159

address-city

Required Field

Student self-reported

Y - Even though the Contact Info API is set up to populate the address, a business decision was made to not populate it in any scenario: https://cvc-oei.atlassian.net/browse/BLQ-159

address-state

Required Field

Student self-reported

Y - Even though the Contact Info API is set up to populate the address, a business decision was made to not populate it in any scenario:

address-zip

Required Field

Student self-reported

Y - Even though the Contact Info API is set up to populate the address, a business decision was made to not populate it in any scenario:

phone

Optional Field

Student self-reported or /contactInfo API

Y

email

Required Field

SSO proxy, Student self-reported, or /contactInfo API.

Y

Residency

Required Field

Self-reported by student, or /contactInfo API populated

  • If HC is set up on Phase 2 APIs, value will be pre-populated and it should not be editable.

  • If HC is not set up on Phase 2 APIs:

    • if validated for the same term, value will be pre-populated and it should not be editable.

    • if student does not have a previous validated status and its for the same term, student will have the ability to self-report the value.

Canvas

Required Field

Canvas HC URL is required and will be passed in all scenarios.

N

AER UI Fields To Display in UI

The following fields should be shown in AER form in the UI:

Field Name

Required/Optional

Origin

Editable Y/N

First Name

Required Field

  • If pre-filled from SSO Proxy or /contactInfo API field should not editable by student.

  • If HC is not set up on Phase 2 APIs, student will manually enter their name.

N

Middle Name

Optional Field

Student self-reported or /contactInfo API

  • Middle name will never come through the proxy. User should have the ability to enter middle name in AER form if they choose.

  • If middle name is passed from the SIS, it should pre-populate in the AER form and user should not have the ability to edit it.

  • If middle name does not come through the SIS, use should have the ability to enter it if they choose in the AER form.

Last Name

Required Field

  • If pre-filled from SSO Proxy or /contactInfo API field should not editable by student.

  • If HC is not set up on Phase 2 APIs, student will manually enter their name.

N

address-streetline1

Required Field

Student self-reported

Y - Even though the Contact Info API is set up to populate the address, a business decision was made to not populate it in any scenario:

address-streetline2

Optional Field

Student self-reported

Y - Even though the Contact Info API is set up to populate the address, a business decision was made to not populate it in any scenario:

address-city

Required Field

Student self-reported


Y - Even though the Contact Info API is set up to populate the address, a business decision was made to not populate it in any scenario:

address-state

Required Field

Student self-reported

Y - Even though the Contact Info API is set up to populate the address, a business decision was made to not populate it in any scenario:

address-zip

Required Field

Student self-reported

Y - Even though the Contact Info API is set up to populate the address, a business decision was made to not populate it in any scenario:

phone

Optional Field

Student self-reported or /contactInfo API

Y

email

Required Field

SSO proxy, Student self-reported, or /contactInfo API.

Y

Residency

Required Field

Self-reported by student, or contactInfo API populated

  • If HC is set up on Phase 2 APIs, value will be pre-populated and it should not be editable.

  • If HC is not set up on Phase 2 APIs:

    • if validated for the same term, value will be pre-populated and it should not be editable.

    • if student does not have a previous validated status and its for the same term, student will have the ability to self-report the value.

Associated JIRAs

 

 

API Documentation

API documentation can be found here: .