createEnrollment: Create Abbreviated Enrollment Record

companyID

e.g. N2N

Unique value to identify the client location.

Yes

Authorization

e.g. AxasdaAAgfsads==

Illuminate Auth token

Yes

Content-Type

application/json

The Content-Type header is used to indicate the media type of the resource

Yes

illuminateApiKey

String

Unique key assigned for a consumer for each client location

Yes

X-Consumer-Tracer-Id

String

Unique tracer Id that belongs to the consumer.

Optional

field

type

description

example

comments

cccId

string

CCCID of the Student

Required. Accepts any CCCID (even if it does not exist)

studentDetails

object

Information about the student

Required

demographicInfo

object

Information about the student’s demographics

Optional

firstName

string

First name of the student

Required

lastName

string

Last name of the student

Required

middleName

string

Middle name

Optional

dateOfBirth

string

Students date of birth

e.g. YYYY-MM-DD

ISO_8601 date format(Required)

emails

array of objects

Array of email address objects

Optional, If an email is sent - emails.[address] is required

address

string

Email address of the students

Optional

phones

array of objects

Array of phone number objects

Optional, If a phone is sent - phones.[number] is required

Number format = "number": "123-456-7890"

number

string

Student’s phone number

Optional

addresses

array of objects

Array of address objects

Optional, If an address is sent StreetLine1, city, state, country, zip are required

StreetLine1

string

Street line 1 of the address

Optional

StreetLine2

string

Street line 2 of the address

Optional

city

string

City

Optional

state

string

State

e.g. Georgia

Optional

Zip

string

Zip code

Optional

country

string

Country

e.g. USA

Optional

campusCode

string

Campus code

Required

termCode

string

Term to which the student enrollment is being processed

Required

residency

string

In / Out state status of the student

Required

residencyValue

string

Y if In-State, N if Out-of-State

Required

source

string

HC if API pulled from HC or if the HC verified. Studentif the student self reports.

Required

promiseGrant

string

Promise grant available indicator (Y: has Promise grant, N - No Promise grant)

Optional

promiseGrantValue

string

Y or N

Optional

source

string

HC if API pulled from HC or if the HC verified. Studentif the student self reports.

Required

homeCollegeInfo

string

Information about the student’s home college

Required

FICECode

string

Home college FICECode

Required

MISCode

string

Home college MIS college code

Required

collegeName

string

Name of the college

Required

canvasRootAccount

string

Canvas root account

Required

sisUserId

string

User ID for SIS

Required

canvasLoginId

string

Canvas Login ID

Required

X-Tracing-Id

e.g. 8-1589911066.164-10.2.3.2-946-1000914

Illuminate API request unique tracing Id

apiVersion

String

Requested API version

X-Consumer-Tracer-Id

String

Unique tracer Id that belongs to the consumer. This will be returned only if the value is passed through Request Headers.

field

type

description

example

comments

status

string

Status of the API call

• success

• fail

This is the status of the API. Status response is case-insensitive.

response

string

Success message or relevant message

200

OK

success

401

Unauthorized

Authorization info missing

401

Unauthorized

companyID is missing

401

Unauthorized

Illuminate API key is missing

412

Precondition Failed

Invalid API Name

412

Precondition Failed

Invalid API Key

412

Precondition Failed

Missing required input fields

500

Internal Server Error

Internal error encountered

502

Bad Gateway

Bad Gateway

502

Service Unavailable

Service Unavailable

504

Gateway Timeout

Gateway Timeout