Resource Overview
-
Ed-Fi endpoint:
/data/v3/students -
Published view/entity: Student ID
-
Purpose: Student Identification
-
Source query:
StudentIdentification -
Dependencies: No resource dependency is declared.
This resource represents an individual for whom instruction, services, and/or care are provided in an early childhood, elementary or secondary educational program under the jurisdiction of a school, education agency, or other institution or program. A student is a person who has been enrolled in a school or other educational institution.
Primary PowerSchool Source Data
-
[Students]
-
[S_TN_STU_X]
-
[StudentCoreFields]
Selection Criteria
Records are published if the following criteria are met:
-
StudentUniqueId must be populated in PowerSchool.
-
The student must not be excluded from state reporting.
-
The student's school of enrollment must not be excluded from state reporting.
-
The student must have at least one school enrollment with an Entry Date that falls within the date range defined by [Terms]FirstDay and [Terms]LastDay for the year of the Term selected in the PowerSchool UI.
Resource Output
|
Data Element (Ed-Fi target) |
Data View Column Name |
Submission |
[Table]Field (PowerSchool Source) |
Business Rules |
Comments |
|---|---|---|---|---|---|
|
studentUniqueId |
StudentUID |
Y |
[Students]DCID Transformation: EDFI_TN_LIB.getStudentUniqueId(p_profileid, s.dcid) |
Required by the production resource definition when the resource is published. |
JSON type: string. Query alias: StudentUID. |
|
firstName |
FirstName |
Y |
[Students]First_name |
Required by the production resource definition when the resource is published. |
JSON type: string. Query alias: FirstName. |
|
middleName |
MiddleName |
Conditional |
[Students]Middle_name |
Submit when the source alias is populated and the parent structure is applicable. |
JSON type: string. Query alias: MiddleName. |
|
lastSurname |
LastName |
Y |
[Students]Last_name; Transformation: trim(case when CST_PUBWORKFLOW_LIB.getGenerationSuffix(p_profileid, s.last_name) is null then s.last_name else substr(trim(s.last_name), 1, instr(trim(s.last_name), ' ', -1)) end ) |
Required by the production resource definition when the resource is published. |
JSON type: string. Query alias: LastName. |
|
generationCodeSuffix |
GenerationCodeSuffix |
Conditional |
[S_TN_STU_X]NameSuffix; [Students]Last_name; Transformation: coalesce(xt.NameSuffix, CST_PUBWORKFLOW_LIB.getGenerationSuffix(p_profileid, s.last_name)) |
Submit when the source alias is populated and the parent structure is applicable. |
JSON type: string. Query alias: GenerationCodeSuffix. |
|
birthDate |
BirthDate |
Y |
[Students]DOB; Transformation: to_char(s.DOB, 'YYYY-MM-DD') |
Required by the production resource definition when the resource is published. |
JSON type: datetime. Query alias: BirthDate. |
|
birthCity |
BirthCity |
Conditional |
[S_TN_STU_X]Countrybirthcode; [S_TN_STU_X]Cityofbirth; Transformation: case when coalesce(xt.countrybirthcode, 'AA') <> 'AA' then xt.cityofbirth end |
Submit when the source alias is populated and the parent structure is applicable. |
JSON type: string. Query alias: BirthCity. |
|
birthInternationalProvince |
BirthIntlProvince_DX |
Conditional |
[S_TN_STU_X]Countrybirthcode; [S_TN_STU_X]Statebirthcode; Transformation: case when coalesce(xt.countrybirthcode, 'AA') not in ('AA','US') and coalesce(xt.statebirthcode, 'AA') <> 'AA' then xt.countrybirthcode || '-' || xt.statebirthcode end |
Submit when the source alias is populated and the parent structure is applicable. |
JSON type: string. Query alias: BirthIntlProvince_DX. |
|
birthCountryDescriptor |
BirthCountry_DX |
Conditional |
[S_TN_STU_X]Countrybirthcode; Transformation: case when coalesce(xt.countrybirthcode, 'AA') <> 'AA' then xt.countrybirthcode end |
Submit when the source alias is populated and the parent structure is applicable. |
JSON type: string. Query alias: BirthCountry_DX. |
|
birthSexDescriptor |
BirthSex_DX |
Conditional |
[Studentcorefields]pscore_legal_gender; [Students]Gender; Transformation: CASE upper(coalesce(scf.pscore_legal_gender, s.gender)) WHEN 'F' THEN 'Female' WHEN 'M' THEN 'Male' ELSE 'Not Selected' END |
Submit when the source alias is populated and the parent structure is applicable. |
JSON type: string. Query alias: BirthSex_DX. |
|
birthStateAbbreviationDescriptor |
BirthState_DX |
Conditional |
[S_TN_STU_X]Countrybirthcode; [S_TN_STU_X]Statebirthcode; Transformation: case when xt.countrybirthcode = 'US' and coalesce(xt.statebirthcode, 'AA') <> 'AA' then xt.statebirthcode end |
Submit when the source alias is populated and the parent structure is applicable. |
JSON type: string. Query alias: BirthState_DX. |
|
citizenshipStatusDescriptor |
CitizenshipStatus_DX |
Conditional |
Staging rule: Students NULL |
Submit when the source alias is populated and the parent structure is applicable. |
JSON type: string. Query alias: CitizenshipStatus_DX. |
|
multipleBirthStatus |
MultipleBirthStatus |
Conditional |
Staging rule: Students NULL |
Submit when the source alias is populated and the parent structure is applicable. |
JSON type: boolean. Query alias: MultipleBirthStatus. |
|
_ext.stateStudentId |
StateStudentId |
Conditional |
[Students]State_StudentNumber |
Submit when the source alias is populated and the parent structure is applicable. |
JSON type: number. Query alias: StateStudentId. |