Table of Contents

Introduction

API Scope and future expansion

What is a RESTful API and web service?

What is xPress Roster?

RIC One Architecture Overview

Normalization

Data Formats: XML and JSON

Identifiers

RefId

Other identifiers

Resources and Relationships

Service Paths

Resource Definitions

Resource Tables Structure

xStudent

xStaff

xRoster

xSchool

xContact

xCourse

xCalendar

xLea

RIC One API Security

About RIC One LOGIN

Additional Resources and Links

Appendix A: Code Sets

Code Sets Table Structure

About SCED Codes

Codified Elements and Values


Introduction

Welcome to RIC One API, an implementation of the xPress Roster standard! The purpose of this manual is to acquaint you with the overall structure and element-level detail of the data aspects of the xPress Roster web service Application Programming Interface (API). It provides introductory material that will explain, at a high level, how the API operates within the implementation developed by New York Regional Information Centers (RICs) and the New York State Education Department. It does not go into significant detail about how to develop an API client for your application but, rather, focuses on the structure and meaning of the data contained within the API. We believe this content makes the manual suitable for use by data analysts who may use various tools to interact with the API indirectly and programmers who may wish to make linkages to other data standards that are derived from the Common Education Data Standards (CEDS) and Access For Learning s Schools Interoperability Framework (SIF).

API Scope and future expansion

The original use case for the API centers on enabling instructional applications to provision staff and student accounts based on associations inherent in course sections. RIC One API/xPress Roster currently provides a specific dataset that, through extensive analysis, has been shown to meet the majority of provisioning needs for many types of educational applications. In addition to identifying elements for students and staff, the API also contains basic demographic data about students; contextual information about districts, schools and courses; and contact data for parents and guardians.

Based on the needs of districts, RICs and vendors, new capabilities and data domains will be added to the API over time. For example, consideration is currently being given to adding support for the grading, attendance and assessment domains. Write operations to appropriate areas of the data model will also likely become supported when the API is extended to these new areas (it is currently read-only).

What is a RESTful API and web service?

Although this manual is primarily focused on the data model of the API, some understanding of a RESTful API and web service should aid your overall understanding of how the system works. RESTful web service APIs are popular with programmers today because they easily facilitate interoperability among systems.

First, an API is an application programming interface. In short, an API is a defined and exposed set of function calls that allows a programmer to invoke a specific action on a system. For example, all operating systems provide a file system API that lets an application read data from a storage device.

Second, a web service is an API that can be called over a web transport protocol. This almost always translates to HTTP and HTTPS in the case of modern web services.

Third, REST stands for REpresentational State Transfer. Put simply, REST is a style of implementation for a web service API based on the underlying technologies and protocols of the Internet. Function calls and interactions with underlying systems and data are modeled using Uniform Resource Identifiers (URI; e.g. https://api.ricone.org/api/requests/xStudents ) and the verbs of the HTTP protocol (e.g. GET, POST, HEAD, etc.)

What is xPress Roster?

xPress Roster is a national standard for exchanging rostering data among systems in K12 schools. xPress Roster defines a RESTful web service API that is published and maintained by a standards developing organization known as the Access 4 Learning Community (www.a4l.org; www.xpressapi.org). xPress Roster was developed early in the RIC One project since, at the time, no other standard existed for conveying rostering data between systems, and existing standards were found to be either too sparse or too complex to easily facilitate adoption among vendors, districts and RICs. RIC One API is essentially an implementation of the national xPress Roster standard.

RIC One Architecture Overview

Before delving into the structure of data elements within the API, it is worthwhile to understand the overall architecture of the RIC One API system. One of the defining characteristics of the system is that data ingestion and storage are physically and geographically distributed across NY State. To allay privacy and security concerns, there is no single database that holds all districts data in one place.

Figure 1: Distributed architecture for privacy and security

This distributed architecture is implemented by deploying a Data Provider Appliance (DPA) within each RIC. A DPA is a self-contained virtual machine that runs all of the necessary components to ingest data from district SISs, transform that data into a common format, aggregate each region s data, and provide an API endpoint for access by developers. To ensure security, ease of maintenance and performance, direct database access is not provided to the DPAs, which means that all data access must take place through the API.

Figure 2: Appliances are self-contained

Although district data is always housed within a RIC, security and command & control functions are centralized, which simplifies access and management. See the section below on RIC One API Security for more details.

Normalization

The optimal normalization (how entities and individual data elements are grouped and structured with respect to each other) of an API generally differs from that of a database. In a database, fields and tables are arranged for storage efficiency, performance and integrity. Since RIC One API/xPress Roster is an on-the-wire representation of data, rather than an on-disk representation, it has been designed for developer convenience and optimized transport. This means that particular elements or fields may be found within multiple API resources.

Data Formats: XML and JSON

RIC One API offers two output data formats, eXtensible Markup Language (XML) and JavaScript Object Notation (JSON). This feature provides more convenience to developers by allowing them to choose which output format best aligns to their existing implementation platforms and languages. In general, XML is broadly supported by a large number of sophisticated and powerful data manipulation tools. JSON is well known for being lightweight, and has become a modern, low level data standard for programming web based applications.

Identifiers

RefId

RIC One API utilizes a Universally Unique Identifier (UUID) as the primary key for resource instances. A UUID is a 128-bit number encoded as 32 hexadecimal digits, with hyphens added for readability. In RIC One API these UUIDs are stored in an element called refId within a given resource. RefId s can be utilized within service paths to hierarchically scope requests for data.

Example UUID/RefId

0B55AF77-C11D-4DB6-B872-B393E2E82FE0

Other identifiers

In addition to the RefId primary key, resources often contain other identifiers that can be used for linking and cross-referencing between systems. Following is a list of the most common other identifiers that are present in RIC One API.

Identifier

Description

Found In

LocalId

The SIS assigned identifier of the entity/resource instance.

xStaff, xStudent, xSchool, xContact, xLea

StateProvinceId

The state assigned identifier of the entity/resource instance (e.g. district or school BEDS code, NYSSIS ID)

xStaff, xStudent, xSchool, xLea

LoginId

The LoginId assigned to the user. Generally used for provisioning accounts in client systems.

xStaff, xStudent, xContact

{resourceName}RefId

A reference to a related resource with the specified name.

xStudent, xStaff, xRoster, xCourse, xSchool, xLea, xContact

Resources and Relationships

Resource is the RESTful term for an object. A resource can also be thought of as a virtual table, or simply collection of data elements. There are currently a total of (8) resources in the xPress Roster API:

Resource

Description

xStudent

Represents an individual student. Contains identifiers, contact information, demographics, school enrollments and links to contacts.

xStaff

Represents an individual staff person (could be teaching or non-teaching staff). Contains identifiers, building assignments and basic contact information.

xRoster

Represents a course section within a school. Includes information about the parent course, section scheduling details, a list of enrolled students, and a list of associated teaching staff.

xCourse

Represents a course taught at a given school. Includes a few more details about the course when compared to the set of elements found in the xRoster resource.

xCalendar

Represents a specific time span or session for a given school. For example, marking periods and attendance periods can both be represented using xCalendar.

xSchool

Represents a specific school within a district/LEA. Includes identifiers, address and contact information for the school.

xLea

Represents a district (aka a Local Education Agency). Includes identifiers, address and contact information for the district/LEA.

xContact

Represents the contacts associated with a student (e.g. parents and guardians). Includes identifiers, address and contact information for the contact.

Following is a diagram that depicts the data relationships among xPress Roster resources:

Service Paths

The URIs in RESTful web service APIs can represent a hierarchical model for accessing and scoping resources in different ways. RIC One API/xPress Roster implements many service paths to provide developers with logical ways of requesting data based on various factors.

The general pattern of a service path looks like the following:

/path_to_parent_resource/{identifier}/requested_resource

In most cases {identifier} is the RefId of a specific instance of the parent resource. In certain cases, the use of a local identifier (e.g. SIS ID) is also supported.

The logical meaning of this specific example:

/xSchools/0B55AF77-C11D-4DB6-B872-B393E2E82FE0/xStudents

is to request all students who are enrolled in the school identified by the RefId 0B55AF77-C11D-4DB6-B872-B393E2E82FE0.

The following table describes the service paths that are available in RIC One API:

Resource

Service Paths

Description

xLeas

/xLeas

Returns all xLea resources that the client has access to on the DPA.

/xLeas/{refId}

Returns a single xLea resource identified by its RefId.

/xSchools/{refId}/xLeas

Returns the single xLea resource to which the identified school belongs.

/xRosters/{refId}/xLeas

Returns the single xLea resource to which the identified roster belongs.

/xStaffs/{refId}/xLeas

Returns the single xLea resource to which the identified staff person is associated.

/xStudents/{refId}/xLeas

Returns the single xLea resource to which the identified student is associated.

/xContacts/{refId}/xLeas

Returns the single xLea resource to which the identified contact is associated.

xSchools

/xSchools

Returns all xSchool resources that the client has access to on the DPA, potentially spanning multiple districts.

/xSchools/{refId}

Returns a single xSchool resource identified by its RefId.

/xLeas/{refId}/xSchools

Returns all xSchool resources associated with the identified LEA.

/xCalendars/{refId}/xSchools

Returns the single xSchool resource associated with the identified calendar.

/xCourses/{refId}/xSchools

Returns the single xSchool resource associated with the identified school.

/xRosters/{refId}/xSchools

Returns the single xSchool resource associated with the identified roster.

/xStaffs/{refId}/xSchools

Returns all of the xSchool resources associated with the identified staff person.

/xStudents/{refId}/xSchools

Returns all of the xSchool resources where the identified student is currently enrolled.

/xContacts/{refId}/xSchools

Returns all of the xSchool resources where the contact s associated students are currently enrolled.

xCalendar

/xCalendars

Returns all xCalendar resources that the client has access to on the DPA, potentially spanning multiple districts.

/xCalendars/{refId}

Returns a single xCalendar resource identified by its RefId.

/xLeas/{refId}/xCalendars

Returns all xCalendar resources associated with the identified LEA.

/xSchools/{refId}/xCalendars

Returns the xCalendar resources associated with the identified school.

xCourses

/xCourses

Returns all xCourse resources that the client has access to on the DPA, potentially spanning multiple districts.

/xCourses/{refId}

Returns a single xCourse resource identified by its RefId.

/xLeas/{refId}/xCourses

Returns all xCourse resources associated with the identified LEA (includes courses from all schools).

/xSchools/{refId}/xCourses

Returns the xCourse resources associated with the identified school.

/xRosters/{refId}/xCourses

Returns the xCourse resource associated with the identified roster.

xRosters

/xRosters

Returns all xRoster resources that the client has access to on the DPA, potentially spanning multiple districts.

/xRosters/{refId}

Returns a single xRoster resource identified by its RefId.

/xLeas/{refId}/xRosters

Returns all xRoster resources associated with the identified LEA (includes courses from all schools).

/xSchools/{refId}/xRosters

Returns all the xRoster resources associated with the identified school.

/xCourses/{refId}/xRosters

Returns all the xRoster resources associated with the identified course.

/xStaffs/{refId}/xRosters

Returns all the xStaff resources associated with the identified roster.

/xStudents/{refId}/xRosters

Returns all the xStudent resources associated with the identified roster.

xStaffs

/xStaffs

Returns all xStaff resources that the client has access on the DPA, potentially spanning multiple districts.

/xStaffs/{refId}

Returns a single xStaff resource identified by its RefId.

/xLeas/{refId}/xStaffs

Returns all xStaff resources associated with the identified LEA/district.

/xSchools/{refId}/xStaffs

Returns all xStaff resources associated with the identified school.

/xCourses/{refId}/xStaffs

Returns all xStaff resources associated with the identified course.

/xRosters/{refId}/xStaffs

Returns all xStaff resources associated with the identified roster.

/xStudents/{refId}/xStaffs

Returns all xStaff resources associated with the identified student.

xStudents

/xStudents

Returns all xStudent resources that the client has access on the DPA, potentially spanning multiple districts.

/xStudents/{refId}

Returns a single xStudent resource identified by its RefId.

/xLeas/{refId}/xStudents

Returns all xStudent resources associated with the identified LEA/district.

/xSchools/{refId}/xStudents

Returns all xStudent resources associated with the identified school.

/xRosters/{refId}/xStudents

Returns all xStudent resources associated with the identified roster.

/xStaffs/{refId}/xStudents

Returns all xStudent resources associated with the identified staff person.

/xContacts/{refId}/xStudents

Returns all xStudent resources associated with the identified contact.

xContacts

/xContacts

Returns all xContact resources that the client has access on the DPA, potentially spanning multiple districts.

/xContacts/{refId}

Returns a single xContact resource identified by its RefId.

/xLeas/{refId}/xContacts

Returns all xContact resources associated with the identified LEA/district.

/xSchools/{refId}/xContacts

Returns all xContact resources associated with the identified school.

/xStudents/{refId}/xContacts

Returns all xContact resources associated with the identified student.

Resource Definitions

This section contains a detailed list of data elements for each of the API resources. The element is shown in xPath notation. The description is generally copied from the Common Education Data Standards (CEDS; http://ceds.ed.gov). The CEDS Code provides the CEDS element identifier used by CEDS for cross referencing purposes. The Codeset column indicates if a particular element is expected to contain codified values. In general, elements that require a specific codeset have their value space defined according to CEDS, NCES handbooks and SIF. See the Code Sets appendix for detailed information on the values and their meanings.

Resource Tables Structure

Element. The qualified name of the element within the specified resource.

Description. A logical, human readable description of the element. Most definitions are used directly from CEDS.

CEDS Code. The CEDS element identifier that this xPress Roster element maps to.

Codified Element. This column contains a flag ( Y ) if the particular element requires the use of a prescribed Code Set. Code Set values are contained within Appendix. A.

xStudent

Represents an individual student. Contains identifiers, contact information, demographics, school enrollments and links to contacts.

Element

Description

CEDS Code

Codified Element

@refId

The refId of the student.

name/type

The types of previous, alternate or other names for a person. Generally the "LegalName" for the primary name.

000634

Y

name/prefix

An appellation, if any, used to denote rank, placement, or status (e.g., Mr., Ms., Reverend, Sister, Dr., Colonel).

000212

name/familyName

The full legal last name borne in common by members of a family.

000172

name/givenName

The full legal first name given to a person at birth, baptism, or through legal change.

000115

name/middleName

A full legal middle name given to a person at birth, baptism, or through legal change.

000184

name/suffix

An appendage, if any, used to denote a person's generation in his family (e.g., Jr., Sr., III).

000121

otherNames/name/type

The types of previous, alternate or other names for a person. Generally the "LegalName" for the primary name.

000634

Y

otherNames/name/prefix

An appellation, if any, used to denote rank, placement, or status (e.g., Mr., Ms., Reverend, Sister, Dr., Colonel).

000212

otherNames/name/familyName

The full legal last name borne in common by members of a family.

000172

otherNames/name/givenName

The full legal first name given to a person at birth, baptism, or through legal change.

000115

otherNames/name/middleName

A full legal middle name given to a person at birth, baptism, or through legal change.

000184

otherNames/name/suffix

An appendage, if any, used to denote a person's generation in his family (e.g., Jr., Sr., III).

000121

localId

A unique number or alphanumeric code assigned to a staff member by a district or LEA.

001071

loginId

The login identifier for the person.

001170

stateProvinceId

A unique number or alphanumeric code assigned to a student by a state.

001071

otherIds/otherId/type

A coding scheme that is used for identification and record-keeping purposes by schools, social services, or other agencies to refer to a student.

001075

Y

otherIds/otherId/id

A unique number or alphanumeric code assigned to a student by a school, school system, a state, or other agency or entity.

001071

address/addressType

The type of address listed for a learner or a parent, guardian, family member or related person.

000010

Y

address/line1

The first line of the address.

000269

address/line2

The second line of the address.

000019

address/city

The name of the city in which an address is located.

00040

address/stateProvince

The abbreviation for the state, province or outlying area in which an address is located.

000267

Y

address/countryCode

The unique two character International Organization for Standardization (ISO) code for the country in which an address is located.

000050

Y

address/postalCode

A number that identifies each postal delivery area in the locale used as a portion of an address.

000214

phoneNumber/phoneNumberType

The type of communication number listed for a person.

000280

Y

phoneNumber/number

The telephone number including the area code, and extension, if applicable.

000279

phoneNumber/primaryIndicator

An indication that the telephone number should be used as the principal number for a person or organization.

000219

otherPhoneNumbers/phoneNumber/phoneNumberType

The type of communication number listed for a person.

000280

Y

otherPhoneNumbers/phoneNumber/number

The telephone number including the area code, and extension, if applicable.

000279

otherPhoneNumbers/phoneNumber/primaryIndicator

An indication that the telephone number should be used as the principal number for a person or organization.

000219

email/emailType

The type of electronic mail (e-mail) address listed for a person or organization.

000089

Y

email/emailAddress

The numbers, letters, and symbols used to identify an electronic mail (e-mail) user within the network to which the person or organization belongs.

000088

otherEmails/email/emailType

The type of electronic mail (e-mail) address listed for a person or organization.

000089

Y

otherEmails/email/emailAddress

The numbers, letters, and symbols used to identify an electronic mail (e-mail) user within the network to which the person or organization belongs.

000088

demographics/races/race/race

Indicates the racial origins of a person. The possible values are: AmericanIndianOrAlaskaNative, Asian, BlackOrAfricanAmerican, NativeHawaiianOrOtherPacificIslander, White, DemographicRaceTwoOrMoreRaces.

Multiple

Y

demographics/hispanicLatinoEthnicity

An indication that the person traces his or her origin or descent to Mexico, Puerto Rico, Cuba, Central and South America, and other Spanish cultures, regardless of race.

000144

demographics/sex

The concept describing the biological traits that distinguish the males and females of a species.

000255

Y

demographics/birthDate

The year, month and day on which a person was born.

000033

demographics/countryOfBirth

000050

Y

demographics/usCitizenshipStatus

An indicator of whether or not the person is a US citizen.

000299

Y

enrollment/leaRefId

RefId of the LEA

enrollment/schoolRefId

RefId of the school.

enrollment/school

The school of enrollment.

enrollment/schoolYear

The year for a reported school term/session. For academic years that span a calendar year this is the four digit year-end. E.g. 2013 for 2012-2013.

000243

enrollment/studentSchoolAssociationRefId

RefId of the SIF Student-School Association object.

enrollment/responsibleSchoolType

The type of services/instruction the school is responsible for providing to the student.

000595

Y

enrollment/membershipType

The student's type of membership in the system.

Y

enrollment/entryDate

The month, day, and year on which a person enters and begins to receive instructional services in a school, institution, program, or class-section during a given session.

000097

enrollment/exitDate

The year, month and day on which the student officially withdrew or graduated, i.e. the date on which the student's enrollment ended.

000107

enrollment/homeRoomNumber

Home Room number.

enrollment/homeRoomTeacher/refId

A SIF RefId.

enrollment/homeRoomTeacher/localId

The local (SIS) ID of the homeRoom teacher.

enrollment/homeRoomTeacher/givenName

The full legal first name given to a person at birth, baptism, or through legal change.

000115

enrollment/homeRoomTeacher/familyName

The full legal last name borne in common by members of a family.

000172

enrollment/gradeLevel

The current grade or academic level of the student within a school.

Y

enrollment/projectedGraduationYear

The year and month the student is projected to graduate.

000226

enrollment/counselor/refId

A SIF RefId.

enrollment/counselor/localId

The local (SIS) ID of the counselor.

enrollment/counselor/givenName

The full legal first name given to a person at birth, baptism, or through legal change.

000115

enrollment/counselor/familyName

The full legal last name borne in common by members of a family.

000172

otherEnrollments/enrollment/leaRefId

RefId of the LEA

otherEnrollments/enrollment/schoolRefId

RefId of the school.

otherEnrollments/enrollment/school

The school of enrollment.

otherEnrollments/enrollment/schoolYear

The year for a reported school term/session. For academic years that span a calendar year this is the four digit year-end. E.g. 2013 for 2012-2013.

000243

otherEnrollments/enrollment/studentSchoolAssociationRefId

RefId of the SIF Student-School Association object.

otherEnrollments/enrollment/responsibleSchoolType

The type of services/instruction the school is responsible for providing to the student.

000595

Y

otherEnrollments/enrollment/membershipType

The student's type of membership in the system.

Y

otherEnrollments/enrollment/entryDate

The month, day, and year on which a person enters and begins to receive instructional services in a school, institution, program, or class-section during a given session.

000097

otherEnrollments/enrollment/exitDate

The year, month and day on which the student officially withdrew or graduated, i.e. the date on which the student's enrollment ended.

000107

otherEnrollments/enrollment/homeRoomNumber

Home Room number

otherEnrollments/enrollment/homeRoomTeacher/refId

A SIF RefId.

otherEnrollments/enrollment/homeRoomTeacher/localId

The local (SIS) ID of the home room teacher.

otherEnrollments/enrollment/homeRoomTeacher/givenName

The full legal first name given to a person at birth, baptism, or through legal change.

000115

otherEnrollments/enrollment/homeRoomTeacher/familyName

The full legal last name borne in common by members of a family.

000172

otherEnrollments/enrollment/gradeLevel

The current grade or academic level of the student within a school.

Y

otherEnrollments/enrollment/projectedGraduationYear

The year and month the student is projected to graduate.

000226

otherEnrollments/enrollment/counselor/refId

A SIF RefId.

otherEnrollments/enrollment/counselor/localId

The local (SIS) ID of the counselor.

otherEnrollments/enrollment/counselor/givenName

The full legal first name given to a person at birth, baptism, or through legal change.

000115

otherEnrollments/enrollment/counselor/familyName

The full legal last name borne in common by members of a family.

000172

academicSummary/cumulativeWeightedGpa

A measure of average performance in all courses taken by a person during his or her school career as determined for record-keeping purposes. This is obtained by dividing the total grade points received by the total number of credits attempted. This usually includes grade points received and credits attempted in his or her current school as well as those transferred from schools in which the person was previously enrolled.

000128

academicSummary/termWeightedGpa

A measure of average performance in all courses taken by a person during a given session. This is obtained by dividing the total grade points received by the number of credits attempted for the same session.

000129

academicSummary/classRank

The academic rank of a student in relation to his or her high school graduating class (e.g., 1, 2, 3) based on high school GPA.

000041

studentContacts/contactPersonRefId

The RefId of the contact object.

languages/language/type

An indication of the function and context in which a person uses a language to communicate.

000316

Y

languages/language/code

The code for the specific language or dialect that a person uses to communicate.

000317

Y

xStaff

Represents an individual staff person (could be teaching or non-teaching staff). Contains identifiers, building assignments and basic contact information.

Element

Description

CEDS Code

Codified Element

@refId

The refId of the staff person.

name/type

The types of previous, alternate or other names for a person. Generally the "LegalName" for the primary name.

000634

Y

name/prefix

An appellation, if any, used to denote rank, placement, or status (e.g., Mr., Ms., Reverend, Sister, Dr., Colonel).

000212

name/familyName

The full legal last name borne in common by members of a family.

000172

name/givenName

The full legal first name given to a person at birth, baptism, or through legal change.

000115

name/middleName

A full legal middle name given to a person at birth, baptism, or through legal change.

000184

name/suffix

An appendage, if any, used to denote a person's generation in his family (e.g., Jr., Sr., III).

000121

localId

A unique number or alphanumeric code assigned to a staff member by a district or LEA.

loginId

The login identifier for the person.

001170

stateProvinceId

A unique number or alphanumeric code assigned to a staff member by a state.

001070

otherIds/otherId/type

A coding scheme that is used for identification and record-keeping purposes by schools, social services, or other agencies to refer to a student.

001075

Y

otherIds/otherId/id

A unique number or alphanumeric code assigned to a student by a school, school system, a state, or other agency or entity.

001071

sex

The concept describing the biological traits that distinguish the males and females of a species.

000255

Y

email/emailType

The type of electronic mail (e-mail) address listed for a person or organization.

000089

Y

email/emailAddress

The numbers, letters, and symbols used to identify an electronic mail (e-mail) user within the network to which the person or organization belongs.

000088

primaryAssignment/leaRefId

The RefId for the LEA Object.

primaryAssignment/schoolRefId

The RefId of the school object.

primaryAssignment/jobFunction

The titles of employment, official status, or rank of education staff.

000087

Y

otherAssignments/staffPersonAssignment/leaRefId

The RefId for the LEA Object.

otherAssignments/staffPersonAssignment/schoolRefId

The RefId of the school object.

otherAssignments/staffPersonAssignment/jobFunction

The titles of employment, official status, or rank of education staff.

000087

Y

xRoster

Represents a course section within a school. Includes information about the parent course, section scheduling details, a list of enrolled students, and a list of associated teaching staff.

Element

Description

CEDS Code

Codified Element

@refId

The refId of the roster/course section.

courseRefId

RefId of the course for this section.

courseTitle

The descriptive name given to a course of study offered in a school or other institution or organization. In departmentalized classes at the elementary, secondary, and postsecondary levels (and for staff development activities), this refers to the name by which a course is identified (e.g., American History, English III). For elementary and other non-departmentalized classes, it refers to any portion of the instruction for which a grade or report is assigned (e.g., reading, composition, spelling, and language arts).

000067

sectionRefId

RefId of the section.

subject

A textual description of the subject of the course.

schoolRefId

RefId of the school.

schoolSectionId

A unique number or alphanumeric code assigned by an institution, school, school system, state, or other agency or entity for a particular course-section.

000978

schoolYear

The year for a reported school session.

000243

sessionCode

A local code given to the session, usually for a session that represents a term within the school year such as a marking term.

000252

schoolCalendarRefId

The RefId of the school calendar.

meetingTimes/meetingTime/timeTableDay

The unique identifier for the locally defined rotation cycle date code when the class meets (e.g., in a two day schedule, valid values could be "A" and "B", or "1" and "2").

000523

meetingTimes/meetingTime/classMeetingDays/bellScheduleDay

The days of the week that the section meets (e.g. "M,T,W,Th,F).

meetingTimes/meetingTime/timeTablePeriod

An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules).

000522

meetingTimes/meetingTime/roomNumber

A unique number or alphanumeric code assigned to a room by a school, school system, state, or other agency or entity.

000364

meetingTimes/meetingTime/classBeginningTime

An indication of the time of day the class begins.

000519

meetingTimes/meetingTime/classEndingTime

An indication of the time of day the class ends.

000520

students/studentReference/refId

A SIF RefId.

students/studentReference/localId

The local (SIS) ID of the student.

students/studentReference/givenName

The full legal first name given to a person at birth, baptism, or through legal change.

000115

students/studentReference/familyName

The full legal last name borne in common by members of a family.

000172

primaryStaff/staffPersonReference/refId

A SIF RefId.

primaryStaff/staffPersonReference/localId

The local (SIS) ID of the staff.

primaryStaff/staffPersonReference/givenName

The full legal first name given to a person at birth, baptism, or through legal change.

000115

primaryStaff/staffPersonReference/familyName

The full legal last name borne in common by members of a family.

000172

primaryStaff/teacherOfRecord

Staff member who has a Teacher of Record responsibility for a Class Section based upon the state's definition of Teacher of Record.

000647

primaryStaff/percentResponsible

A percentage used to weight the educator's assigned responsibility for student learning in a Class Section, particularly when more than one educator is assigned to the class section.

000649

otherStaffs/otherStaff/staffPersonReference/refId

A SIF RefId.

otherStaffs/otherStaff/staffPersonReference/localId

The local (SIS) ID of the staff.

otherStaffs/otherStaff/staffPersonReference/givenName

The full legal first name given to a person at birth, baptism, or through legal change.

000115

otherStaffs/otherStaff/staffPersonReference/familyName

The full legal last name borne in common by members of a family.

000172

otherStaffs/otherStaff/teacherOfRecord

Staff member who has a Teacher of Record responsibility for a Class Section based upon the state's definition of Teacher of Record.

000647

otherStaffs/otherStaff/percentResponsible

A percentage used to weight the educator's assigned responsibility for student learning in a Class Section, particularly when more than one educator is assigned to the class section.

000649

xSchool

Represents a specific school within a district/LEA. Includes identifiers, address and contact information for the school.

Element

Description

CEDS Code

Codified Element

@refId

The refId of the school.

leaRefId

Refid of the LEA of which the school is a part.

localId

A unique number or alphanumeric code assigned to a school by a district or LEA.

001071

stateProvinceId

A unique number or alphanumeric code assigned to a school by a state.

001071

otherIds/otherId/type

A coding scheme that is used for identification and record-keeping purposes by schools, social services, or other agencies to refer to an organization.

000827

Y

otherIds/otherId/id

A unique number or alphanumeric code assigned to an organization by a school, school system, a state, or other agency or entity.

000826

schoolName

The full legally accepted name of the institution.

000191

gradeLevels/gradeLevel

Y

address/addressType

The type of address listed for an organization. Generally the mailing address.

001066

Y

address/line1

The first line of the address.

000269

address/line2

The second line of the address.

000019

address/city

The name of the city in which an address is located.

000040

address/stateProvince

The abbreviation for the state, province or outlying area in which an address is located.

000267

Y

address/countryCode

The unique two character International Organization for Standardization (ISO) code for the country in which an address is located.

000050

Y

address/postalCode

A number that identifies each postal delivery area in the locale used as a portion of an address.

000214

phoneNumber/phoneNumberType

The type of communication number listed for a person.

000280

Y

phoneNumber/number

The telephone number including the area code, and extension, if applicable.

000279

phoneNumber/primaryIndicator

An indication that the telephone number should be used as the principal number for a person or organization.

000219

otherPhoneNumbers/phoneNumber/phoneNumberType

The type of communication number listed for a person.

000280

Y

otherPhoneNumbers/phoneNumber/number

The telephone number including the area code, and extension, if applicable.

000279

otherPhoneNumbers/phoneNumber/primaryIndicator

An indication that the telephone number should be used as the principal number for a person or organization.

000219

xContact

Represents the contacts associated with a student (e.g. parents and guardians). Includes identifiers, address and contact information for the contact.

Element

Description

CEDS Code

Codified Element

@refId

The refId of the contact person.

name/type

The types of previous, alternate or other names for a person. Generally the "LegalName" for the primary name.

000634

Y

name/prefix

An appellation, if any, used to denote rank, placement, or status (e.g., Mr., Ms., Reverend, Sister, Dr., Colonel).

000212

name/familyName

The full legal last name borne in common by members of a family.

000172

name/givenName

The full legal first name given to a person at birth, baptism, or through legal change.

000115

name/middleName

A full legal middle name given to a person at birth, baptism, or through legal change.

000184

name/suffix

An appendage, if any, used to denote a person's generation in his family (e.g., Jr., Sr., III).

000121

otherNames/name/type

The types of previous, alternate or other names for a person. Generally the "LegalName" for the primary name.

000634

Y

otherNames/name/prefix

An appellation, if any, used to denote rank, placement, or status (e.g., Mr., Ms., Reverend, Sister, Dr., Colonel).

000212

otherNames/name/familyName

The full legal last name borne in common by members of a family.

000172

otherNames/name/givenName

The full legal first name given to a person at birth, baptism, or through legal change.

000115

otherNames/name/middleName

A full legal middle name given to a person at birth, baptism, or through legal change.

000184

otherNames/name/suffix

An appendage, if any, used to denote a person's generation in his family (e.g., Jr., Sr., III).

000121

localId

A unique number or alphanumeric code assigned to a staff member by a district or LEA.

loginId

The login identifier for the person.

001170

otherIds/otherId/type

A coding scheme that is used for identification and record-keeping purposes by schools, social services, or other agencies to refer to a student.

001075

Y

otherIds/otherId/id

A unique number or alphanumeric code assigned to a student by a school, school system, a state, or other agency or entity.

001071

address/addressType

The type of address listed for a learner or a parent, guardian, family member or related person.

000010

Y

address/line1

The first line of the address.

000269

address/line2

The second line of the address.

000019

address/city

The name of the city in which an address is located.

00040

address/stateProvince

The abbreviation for the state, province or outlying area in which an address is located.

000267

Y

address/countryCode

The unique two character International Organization for Standardization (ISO) code for the country in which an address is located.

000050

Y

address/postalCode

A number that identifies each postal delivery area in the locale used as a portion of an address.

000214

phoneNumber/phoneNumberType

The type of communication number listed for a person.

000280

Y

phoneNumber/number

The telephone number including the area code, and extension, if applicable.

000279

phoneNumber/primaryIndicator

An indication that the telephone number should be used as the principal number for a person or organization.

000219

otherPhoneNumbers/phoneNumber/phoneNumberType

The type of communication number listed for a person.

000280

otherPhoneNumbers/phoneNumber/number

The telephone number including the area code, and extension, if applicable.

000279

otherPhoneNumbers/phoneNumber/primaryIndicator

An indication that the telephone number should be used as the principal number for a person or organization.

000219

email/emailType

The type of electronic mail (e-mail) address listed for a person or organization.

000089

Y

email/emailAddress

The numbers, letters, and symbols used to identify an electronic mail (e-mail) user within the network to which the person or organization belongs.

000088

otherEmails/email/emailType

The type of electronic mail (e-mail) address listed for a person or organization.

000089

Y

otherEmails/email/emailAddress

The numbers, letters, and symbols used to identify an electronic mail (e-mail) user within the network to which the person or organization belongs.

000088

sex

The concept describing the biological traits that distinguish the males and females of a species.

000255

Y

employerType

A code that defines the employer type.

Y

relationships/relationship/studentRefId

relationships/relationship/relationshipCode

Y

relationships/relationship/restrictions

Restrictions for student and/or teacher contact with the individual (e.g., the student may not be picked up by the individual.

001424

relationships/relationship/livesWith

Indicates whether or not the learner lives with the related person.

001425

relationships/relationship/primaryContactIndicator

Indicates that a person is a primary contact within the specified context, such as a primary parental contact specified in Person Relationship to Learner or a primary administrative contact for an organization.

001428

relationships/relationship/emergencyContactIndicator

Indicates whether or not the person is a designated emergency contact for the learner.

001341

relationships/relationship/financialResponsibilityIndicator

relationships/relationship/custodialIndicator

relationships/relationship/communicationsIndicator

relationships/relationship/contactSequence

The numeric order in the preferred sequence and priority for contacting a person related to the learner.

001423


xCourse

Represents a course taught at a given school. Includes a few more details about the course when compared to the set of elements found in the xRoster resource.

Element

Description

CEDS Code

Codified Element

@refId

The refId of the course.

schoolRefId

Refid of the school in which the course is delivered.

schoolCourseId

The actual code that identifies the organization of subject matter and related learning experiences provided for the instruction of students.

000055

leaCourseId

The actual code that identifies the organization of subject matter and related learning experiences provided for the instruction of students as defined at the district level (i.e. district course code).

000055

otherIds/otherId/type

A system that is used to identify the organization of subject matter and related learning experiences provided for the instruction of students.

000056

Y

otherIds/otherId/id

The actual code that identifies the organization of subject matter and related learning experiences provided for the instruction of students.

000055

courseTitle

The descriptive name given to a course of study offered in a school or other institution or organization. In departmentalized classes at the elementary, secondary, and postsecondary levels (and for staff development activities), this refers to the name by which a course is identified (e.g., American History, English III). For elementary and other non-departmentalized classes, it refers to any portion of the instruction for which a grade or report is assigned (e.g., reading, composition, spelling, and language arts).

000067

description

A description of the course content and/or goals. Reference may be made to state or national content standards.

000517

subject

A textual description of the subject of the course.

applicableEducationLevels/applicableEducationLevel

The education level, grade level or primary instructional level at which a course is intended.

001301

Y

scedCourseCode

SCED code for the course.

001517

Y

scedCourseLevelCode

SCED Course Level Code.

001516

Y

scedCourseSubjectAreaCode

SCED Course Subject Area Code.

001518

Y

xCalendar

Represents a specific time span or session for a given school. For example, marking periods and attendance periods can both be represented using xCalendar.

Element

Description

CEDS Code

Codified Element

@refId

The refId of the calendar.

schoolRefId

The refid to which this calendar applies.

schoolYear

The school year for the calendar.

sessions/sessionList/sessionType

A prescribed span of time when an education institution is open, instruction is provided, and students are under the direction and guidance of teachers and/or education institution administration. A session may be interrupted by one or more vacations.

000254

Y

sessions/sessionList/sessionCode

A local code given to the session, usually for a session that represents a term within the school year such as a marking term.

001270

sessions/sessionList/description

A short description of the Session.

001271

sessions/sessionList/markingTerm

Indicates that the session is a marking term.

001272

sessions/sessionList/schedulingTerm

Indicates that the session is a scheduling term.

001273

sessions/sessionList/linkedSessionCode

Enables sessions to be linked (e.g. link a marking term to a scheduling term)

sessions/sessionList/startDate

The year, month and day on which a session begins.

000251

sessions/sessionList/endDate

The year, month and day on which a session ends.

000253

xLea

Represents a district (aka Local Education Agency). Includes identifiers, address and contact information for the district/LEA.

Element

Description

CEDS Code

Codified Element

@refId

localId

A unique number or alphanumeric code assigned to a local education agency by a school system.

001068

leaRefId

The refId for the LEA.

stateProvinceId

A unique number or alphanumeric code assigned to a local education agency by a state.

001068

ncesId

A unique number or alphanumeric code assigned to a local education agency by NCES.

001068

leaName

The name of a non-person entity such as an organization, institution, agency or business; in this case, a Local Education Agency.

000204

address/addressType

The type of address listed for an organization. Generally the mailing address.

001066

Y

address/line1

The first line of the address.

000269

address/line2

The second line of the address.

000019

address/city

The name of the city in which an address is located.

000040

address/stateProvince

The abbreviation for the state, province or outlying area in which an address is located.

000267

Y

address/countryCode

The unique two character International Organization for Standardization (ISO) code for the country in which an address is located.

000050

Y

address/postalCode

A number that identifies each postal delivery area in the locale used as a portion of an address.

000214

phoneNumber/phoneNumberType

The type of communication number listed for a person.

000280

Y

phoneNumber/number

The telephone number including the area code, and extension, if applicable.

000279

phoneNumber/primaryIndicator

An indication that the telephone number should be used as the principal number for a person or organization.

000219

otherPhoneNumbers/phoneNumber/phoneNumberType

The type of communication number listed for a person.

000280

Y

otherPhoneNumbers/phoneNumber/number

The telephone number including the area code, and extension, if applicable.

000279

otherPhoneNumbers/phoneNumber/primaryIndicator

An indication that the telephone number should be used as the principal number for a person or organization.

000219

RIC One API Security

This section briefly touches on RIC One API security, primarily because of its impact on the scope of data access from a client s perspective. Access control to district data is handled by a centralized security service that governs all of the DPAs. Applications are granted access to an individual district s data based on a district approval process.

During the application authentication process, the security service returns a list of the DPA endpoints that the application has been granted access to, which is based on where district data resides. In other words, an application s access to a district s data implicitly provides the link to the appropriate DPA.

About RIC One LOGIN

RIC One is comprised of two companion services, API and LOGIN. As you have seen, the API service provides a modern approach to interoperability by way of a RESTful web service. RIC One LOGIN provides single sign on to applications using industry standard protocols. The two services can be independently adopted by districts and RICs, but are designed to work together.

Additional Resources and Links

Resource/Link

Description

http://sandbox.ricone.org

Sandbox provides an interactive user interface to a set of sample data on the API.

API developer s guide

A guide to developing a client that will your application to connect to RIC One API.

.NET client library documentation

Java client library documentation

We have developed dedicated .NET and Java client libraries that make authenticating and parsing data easy for developers. These two guides document how to put these open source libraries to work.

Access 4 Learning website

The website for the Access 4 Learning Community, the maintainer of the SIF specifications and the xPress API suite. The specifications area of this site contains more information about the RESTful transport specification and enterprise data model.

Fielding s dissertation on REST

Fielding s full paper on RESTful architecture.


Appendix A: Code Sets

A number of data elements within RIC One require the use of prescribed Code Sets. The primary goal of using Code Sets is to achieve interoperability among the broadest number of systems by standardizing on a defined set of values and their underlying meaning. The values provided by the Common Education Data Standards (CEDS) are used in the majority of xPress data elements that require the use of Code Sets. The following table lists the codesets and the elements they apply to.

Code Sets Table Structure

xPress Codeset/CEDS Element Name. A logical name, generally defined by CEDS, for the Code Set. If the text (additional values) appears in this cell, it means that the base Code Set has been extended with the specified values due to a less then optimal match with an underlying CEDS codeset.

Included Within. A qualified list of the elements that use the indicated values.

Source. The source from which the prescribed value was derived. In general, most values come directly from CEDS. Particular Code Sets utilize values from other sources, or are defined specifically for use within xPress to convey meaning that does not align well to other sources.

Definition URL. A URL at which additional defining material about the element can be found.

Values. The values that are prescribed for use in the element.

About SCED Codes

The xCourse resources contains three elements that refer to an externally defined codeset known as School Codes for the Exchange of Data (SCED). SCED codes provide a way to more precisely articulate course definitions across schools, districts and states. This Code Set is defined and maintained by the National Center for Education Statistics. More information, including the codes and their definitions, can be found at http://nces.ed.gov/forum/SCED.asp.

Codified Elements and Values

xPress Codeset/
CEDS Element Name

Included Within

Source

Definition URL

Values

AddressTypeForLearnerOrFamily

xStudent/address/addressType, xContact/address/addressType

CEDS

https://ceds/ed/gov/CEDSElementDetails/aspx?TermxTopicId=29130

"Mailing","Physical","Shipping","Billing","OnCampus","OffCampus","PermanentStudent","PermanentAdmission","FatherAddress","MotherAddress","GuardianAddress"

AddressTypeOfOrganization

xLea/address/addressType, xSchool/address/addressType

CEDS

https://ceds/ed/gov/CEDSElementDetails/aspx?TermxTopicId=31206

"Mailing","Physical","Shipping"

CountryCode

xStudent/address/countryCode, xStudent/demographics/countryOfBirth, xLea/address/countryCode, xSchool/address/countryCode, xContact/address/countryCode

CEDS

https://ceds/ed/gov/CEDSElementDetails/aspx?TermxTopicId=27619

"AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"

CourseCodeSystem

xCourse/type

CEDS

https://ceds/ed/gov/CEDSElementDetails/aspx?TermxTopicId=28926

"Intermediate","LEA","NCES","Other","SCED","School","State","University"

EducationStaffClassificationSystem

xStaff/primaryAssignment/jobFunction, xstaff/staffPersonAssignment/jobFunction

CEDS

https://ceds/ed/gov/CEDSElementDetails/aspx?TermxTopicId=28080

"Administrative Support Staff","Administrators","All Other Support Staff","Behavioral Specialists","Early Learning Assistant Teachers","Early Learning Teachers","Elementary Teachers","Family Service Workers","Health Specialists","Home Visitors","Instructional Coordinators","Kindergarten Teachers","Librarians/Media Specialists","Library/Media Support Staff","Mental Health Specialists","Nutrition Specialists","Paraprofessionals","Part C Early Interventionists","Part C Service Coordinators","School Counselors","Secondary Teachers","Social Workers","Special Education Teachers","Special Needs Specialists","Student Support Services Staff","Ungraded Teachers"

ElectronicMailAddressType

xStudent/email/emailType, xStudent/otherEmails/email/emailType, xStaff/email/emailType, xContact/email/emailType, xContact/otherEmails/email/emailType

https://ceds/ed/gov/CEDSElementDetails/aspx?TermxTopicId=28978

"Home","Work","Organizational","Other"

EmployerType

xContact/employerType

SIF2/7/NCES 0614

http://specification/sifassociation/org/Implementation/us/2/7M/html/ExternalCodeSets/html#NCES0614EmployerTypeType

"Government_1803","Military_1804","PrivateOrganization_1805","Self-employed_1806","MilitaryDepartmentOfDefense_1807","AgriculturalFisherySeasonal_1808","Other_9999"

GradeLevel

xStudent/enrollment/gradeLevel, xCourse/applicableEducationLevel

CEDS

https://ceds/ed/gov/CEDSElementDetails/aspx?TermxTopicId=28749

"IT","PR","PK","TK","KG","01","02","03","04","05","06","07","08","09","10","11","12","13","PS","UG","Other"

InstitutionTelephoneNumberType

xLea/phoneNumber/phoneNumberType, xLea/otherPhoneNumbers/phoneNumber/phoneNumberType, xSchool/phoneNumber/phoneNumberType, xSchool/otherPhoneNumbers/phoneNumber/phoneNumberType

CEDS

https://ceds/ed/gov/CEDSElementDetails/aspx?TermxTopicId=31212

"FAX","Main","Administrative","HealthClinic","Attendance","FoodServices","Other"

LanguageCode

xStudent/languages/language/code

CEDS

https://ceds/ed/gov/CEDSElementDetails/aspx?TermxTopicId=28597

"aar","abk","ace","ach","ada","ady","afa","afh","afr","ain","aka","akk","alb","ale","alg","alt","amh","ang","anp","apa","ara","arc","arg","arm","arn","arp","art","arw","asm","ast","ath","aus","ava","ave","awa","aym","aze","bad","bai","bak","bal","bam","ban","baq","bas","bat","bej","bel","bem","ben","ber","bho","bih","bik","bin","bis","bla","bnt","bos","bra","bre","btk","bua","bug","bul","bur","byn","cad","cai","car","cat","cau","ceb","cel","cha","chb","che","chg","chi","chk","chm","chn","cho","chp","chr","chu","chv","chy","cmc","cop","cor","cos","cpe","cpf","cpp","cre","crh","crp","csb","cus","cze","dak","dan","dar","day","del","den","dgr","din","div","doi","dra","dsb","dua","dum","dut","dyu","dzo","efi","egy","eka","elx","eng","enm","epo","est","ewe","ewo","fan","fao","fat","fij","fil","fin","fiu","fon","fre","frm","fro","frr","frs","fry","ful","fur","gaa","gay","gba","gem","geo","ger","gez","gil","gla","gle","glg","glv","gmh","goh","gon","gor","got","grb","grc","gre","grn","gsw","guj","gwi","hai","hat","hau","haw","heb","her","hil","him","hin","hit","hmn","hmo","hrv","hsb","hun","hup","iba","ibo","ice","ido","iii","ijo","iku","ile","ilo","ina","inc","ind","ine","inh","ipk","ira","iro","ita","jav","jbo","jpn","jpr","jrb","kaa","kab","kac","kal","kam","kan","kar","kas","kau","kaw","kaz","kbd","kha","khi","khm","kho","kik","kin","kir","kmb","kok","kom","kon","kor","kos","kpe","krc","krl","kro","kru","kua","kum","kur","kut","lad","lah","lam","lao","lat","lav","lez","lim","lin","lit","lol","loz","ltz","lua","lub","lug","lui","lun","luo","lus","mac","mad","mag","mah","mai","mak","mal","man","mao","map","mar","mas","may","mdf","mdr","men","mga","mic","min","mis","mkh","mlg","mlt","mnc","mni","mno","moh","mon","mos","mul","mun","mus","mwl","mwr","myn","myv","nah","nai","nap","nau","nav","nbl","nde","ndo","nds","nep","new","nia","nic","niu","nno","nob","nog","non","nor","nqo","nso","nub","nwc","nya","nym","nyn","nyo","nzi","oci","oji","ori","orm","osa","oss","ota","oto","paa","pag","pal","pam","pan","pap","pau","peo","per","phi","phn","pli","pol","pon","por","pra","pro","pus","que","raj","rap","rar","roa","roh","rom","rum","run","rup","rus","sad","sag","sah","sai","sal","sam","san","sas","sat","scn","sco","sel","sem","sga","sgn","shn","sid","sin","sio","sit","sla","slo","slv","sma","sme","smi","smj","smn","smo","sms","sna","snd","snk","sog","som","son","sot","spa","srd","srn","srp","srr","ssa","ssw","suk","sun","sus","sux","swa","swe","syc","syr","tah","tai","tam","tat","tel","tem","ter","tet","tgk","tgl","tha","tib","tig","tir","tiv","tkl","tlh","tli","tmh","tog","ton","tpi","tsi","tsn","tso","tuk","tum","tup","tur","tut","tvl","twi","tyv","udm","uga","uig","ukr","umb","und","urd","uzb","vai","ven","vie","vol","vot","wak","wal","war","was","wel","wen","wln","wol","xal","xho","yao","yap","yid","yor","ypk","zap","zbl","zen","zha","znd","zul","zun","zxx","zza"

LanguageType

xStudent/languages/language/type

CEDS

https://ceds/ed/gov/CEDSElementDetails/aspx?TermxTopicId=28828

"Correspondence","Dominant","Home","Native","OtherLanguageProficiency","Other"

MembershipType

xStudent/enrollment/membershipType, xStudent/otherEnrollments/enrollment/membershipType

SIF2/7

http://specification/sifassociation/org/Implementation/us/2/7M/html/StudentInformationSystemsWorkingGroup/html#StudentSchoolEnrollment___MembershipType

"Home","Concurrent","Summer"

NameType

xStudent/name/nameType, xStudent/otherNames/name/type, xStaff/name/nameType, xStudent/otherNames/name/type, xContact/name/type, xContact/otherNames/name/type

CEDS

https://ceds/ed/gov/CEDSElementDetails/aspx?TermxTopicId=30304

"Alias","Nickname","OtherName","PreviousLegalName"

NameType

(additional values)

xStudent/name/nameType, xStudent/otherNames/name/type, xStaff/name/nameType, xStudent/otherNames/name/type, xContact/name/type, xContact/otherNames/name/type

xPress

"LegalName"

NameType

(additional values)

xStudent/name/nameType, xStudent/otherNames/name/type, xStaff/name/nameType, xStudent/otherNames/name/type, xContact/name/type, xContact/otherNames/name/type

xPress

"PreferredName"

OrganizationIdentificationSystem

xSchool/otherIds/otherId/type

CEDS

https://ceds/ed/gov/CEDSElementDetails/aspx?TermxTopicId=29283

"School","ACT","LEA","SEA","NCES","Federal","DUNS","OtherFederal","Other","SSN"

OrganizationIdentificationSystem

(additional values)

xSchool/otherIds/otherId/type

xPress

"Vendor"

PersonIdentificationSystem (additional values)

xStudent/otherIds/otherId/type, xStaff/otherIds/otherId/type, xContact/otherIds/otherId/type

CEDS

https://ceds/ed/gov/CEDSElementDetails/aspx?TermxTopicId=31388

"SSN","USVisa","PIN","Federal","DriversLicense","Medicaid","Healthcare","ProfessionalCertificate","School","District","State","Institution","OtherFederal","SelectiveService","CanadianSIN","Other"

PersonIdentificationSystem (additional values)

xStudent/otherIds/otherId/type, xStaff/otherIds/otherId/type, xContact/otherIds/otherId/type

xPress

"LoginId"

PersonIdentificationSystem (additional values)

xContact/relationships/relationship/relationshipCode

CEDS

https://ceds/ed/gov/CEDSElementDetails/aspx?TermxTopicId=28157

"Aunt","Brother","BrotherInLaw","CourtAppointedGuardian","Daughter","DaughterInLaw","Employer","Father","FathersSignificantOther","FathersCivilPartner","FatherInLaw","Fiance","Fiancee","Friend","Grandfather","Grandmother","Husband","MothersSignificantOther","Mother","MothersCivilPartner","Nephew","Niece","Other","SignificantOther","Sister","Son","Unknown","Uncle","Ward","Wife"

Race

xStudent/demographics/races/race/race

CEDS

https://ceds/ed/gov/element/000016,https://ceds/ed/gov/element/000020,https://ceds/ed/gov/element/000034,https://ceds/ed/gov/element/000192,https://ceds/ed/gov/element/000301,https://ceds/ed/gov/element/000973

"AmericanIndianOrAlaskaNative","Asian","BlackOrAfricanAmerican","NativeHawaiianOrOtherPacificIslander","White","DemographicRaceTwoOrMoreRaces"

ResponsibleSchoolType

xStudent/enrollment/responsibleSchoolType, xStudent/otherEnrollments/enrollment/responsibleSchoolType

CEDS

https://ceds/ed/gov/CEDSElementDetails/aspx?TermxTopicId=28894

"Accountability","Attendance","Funding","Graduation","IEP","Transportation"

SessionType

xCalendar/sessions/sessionList/sessionType

CEDS

https://ceds/ed/gov/CEDSElementDetails/aspx?TermxTopicId=31244

"FullSchoolYear","Intersession","LongSession","MiniTerm","Quarter","Quinmester","Semester","SummerTerm","Trimester","TwelveMonth","Other"

SessionType

(additional values)

xCalendar

xPress

"MarkingPeriod"

SessionType

(additional values)

xCalendar

xPress

"Summer"

Sex

xStudent/demographics/sex, xStaff/sex, xContact/sex

CEDS

https://ceds/ed/gov/CEDSElementDetails/aspx?TermxTopicId=31470

"Male","Female"

StateCode

xStudent/address/stateProvince, xContact/address/stateProvince, xLea/address/stateProvince, xSchool/address/stateProvince

CEDS

https://ceds/ed/gov/CEDSElementDetails/aspx?TermxTopicId=28972

"AK","AL","AR","AS","AZ","CA","CO","CT","DC","DE","FL","FM","GA","GU","HI","IA","ID","IL","IN","KS","KY","LA","MA","MD","ME","MH","MI","MN","MO","MP","MS","MT","NC","ND","NE","NH","NJ","NM","NV","NY","OH","OK","OR","PA","PR","PW","RI","SC","SD","TN","TX","UT","VA","VI","VT","WA","WI","WV","WY"

TelephoneNumberType

xStudent/phoneNumber/phoneNumberType, xStudent/otherPhoneNumbers/phoneNumber/phoneNumberType, xStaff/phoneNumber/phoneNumberType, xStaff//otherPhoneNumbers/phoneNumber/phoneNumberType, xContact/phoneNumber/phoneNumberType, /otherPhoneNumbers/phoneNumber/phoneNumberType

CEDS

https://ceds/ed/gov/CEDSElementDetails/aspx?TermxTopicId=29210

"Home","Work","Mobile","Fax","Other"

TelephoneNumberType

(additional values)

xStudent/phoneNumber/phoneNumberType, xStudent/otherPhoneNumbers/phoneNumber/phoneNumberType, xStaff/phoneNumber/phoneNumberType, xStaff//otherPhoneNumbers/phoneNumber/phoneNumberType, xContact/phoneNumber/phoneNumberType, /otherPhoneNumbers/phoneNumber/phoneNumberType

xPress

"Text"

USCitizenshipStatus

xStudent/demographics/usCitizenshipStatus

CEDS

https://ceds/ed/gov/CEDSElementDetails/aspx?TermxTopicId=29177

"USCitizen","PermanentResident","ResidentAlien","NonResidentAlien","Refugee"

Page