SIF Data Model Implementation Specification (NA) 3.5
Table of Contents

studentLocatorResults

http://www.sifassociation.org/datamodel/na/3.5

Documentation

A potential student match to the search critieria you provided. The results of a search for a student by demographic information are returned in order of confidence in the potential match. If more than one match is found, all results are returned and each is marked as "ambigious." If only one match is found and the provider finds no ambiguities in matches, the match is returned as "confirmed." These results are meant to be reviewed by a human who can select and use the proper matching record.

Tree

studentLocatorResults 0 @refId 1 matchConfidence 2 rel 3 href 4 link 4--2 4--3 5 links 5--4 6 @refId 7 type 8 prefix 9 familyName 10 givenName 11 middleName 12 suffix 13 name 13--7 13--8 13--9 13--10 13--11 13--12 14 type 15 prefix 16 familyName 17 givenName 18 middleName 19 suffix 20 name 20--14 20--15 20--16 20--17 20--18 20--19 21 otherNames 21--20 22 localId 23 loginId 24 stateProvinceId 25 type 26 id 27 otherId 27--25 27--26 28 otherIds 28--27 29 addressType 30 line1 31 line2 32 city 33 stateProvince 34 countryCode 35 postalCode 36 address 36--29 36--30 36--31 36--32 36--33 36--34 36--35 37 addressType 38 line1 39 line2 40 city 41 stateProvince 42 countryCode 43 postalCode 44 name 44--37 44--38 44--39 44--40 44--41 44--42 44--43 45 otherAddresses 45--44 46 phoneNumberType 47 number 48 primaryIndicator 49 phoneNumber 49--46 49--47 49--48 50 phoneNumberType 51 number 52 primaryIndicator 53 phoneNumber 53--50 53--51 53--52 54 otherPhoneNumbers 54--53 55 emailType 56 emailAddress 57 email 57--55 57--56 58 emailType 59 emailAddress 60 email 60--58 60--59 61 otherEmails 61--60 62 race 63 race 63--62 64 races 64--63 65 hispanicLatinoEthnicity 66 sex 67 birthDate 68 countryOfBirth 69 usCitizenshipStatus 70 demographics 70--64 70--65 70--66 70--67 70--68 70--69 71 leaRefId 72 schoolRefId 73 studentSchoolAssociationRefId 74 responsibleSchoolType 75 membershipType 76 entryDate 77 exitDate 78 exitOrWithdrawalType 79 homeRoomNumber 80 refId 81 localId 82 givenName 83 familyName 84 homeRoomTeacher 84--80 84--81 84--82 84--83 85 gradeLevel 86 projectedGraduationYear 87 refId 88 localId 89 givenName 90 familyName 91 counselor 91--87 91--88 91--89 91--90 92 enrollment 92--71 92--72 92--73 92--74 92--75 92--76 92--77 92--78 92--79 92--84 92--85 92--86 92--91 93 leaRefId 94 schoolRefId 95 studentSchoolAssociationRefId 96 responsibleSchoolType 97 membershipType 98 entryDate 99 exitDate 100 exitOrWithdrawalType 101 homeRoomNumber 102 refId 103 localId 104 givenName 105 familyName 106 homeRoomTeacher 106--102 106--103 106--104 106--105 107 gradeLevel 108 projectedGraduationYear 109 refId 110 localId 111 givenName 112 familyName 113 counselor 113--109 113--110 113--111 113--112 114 enrollment 114--93 114--94 114--95 114--96 114--97 114--98 114--99 114--100 114--101 114--106 114--107 114--108 114--113 115 otherEnrollments 115--114 116 cumulativeWeightedGpa 117 termWeightedGpa 118 classRank 119 academicSummary 119--116 119--117 119--118 120 contactPersonRefId 121 @refId 122 type 123 prefix 124 familyName 125 givenName 126 middleName 127 suffix 128 name 128--122 128--123 128--124 128--125 128--126 128--127 129 type 130 prefix 131 familyName 132 givenName 133 middleName 134 suffix 135 name 135--129 135--130 135--131 135--132 135--133 135--134 136 otherNames 136--135 137 localId 138 loginId 139 type 140 id 141 otherId 141--139 141--140 142 otherIds 142--141 143 addressType 144 line1 145 line2 146 city 147 stateProvince 148 countryCode 149 postalCode 150 address 150--143 150--144 150--145 150--146 150--147 150--148 150--149 151 phoneNumberType 152 number 153 primaryIndicator 154 phoneNumber 154--151 154--152 154--153 155 phoneNumberType 156 number 157 primaryIndicator 158 phoneNumber 158--155 158--156 158--157 159 otherPhoneNumbers 159--158 160 emailType 161 emailAddress 162 email 162--160 162--161 163 emailType 164 emailAddress 165 email 165--163 165--164 166 otherEmails 166--165 167 sex 168 employerType 169 studentRefId 170 relationshipCode 171 restrictions 172 livesWith 173 primaryContactIndicator 174 emergencyContactIndicator 175 financialResponsibilityIndicator 176 custodialIndicator 177 communicationsIndicator 178 contactSequence 179 relationship 179--169 179--170 179--171 179--172 179--173 179--174 179--175 179--176 179--177 179--178 180 relationships 180--179 181 xContact 181--121 181--128 181--136 181--137 181--138 181--142 181--150 181--154 181--159 181--162 181--166 181--167 181--168 181--180 182 studentContacts 182--120 182--181 183 type 184 code 185 language 185--183 185--184 186 languages 186--185 187 student 187--6 187--13 187--21 187--22 187--23 187--24 187--28 187--36 187--45 187--49 187--54 187--57 187--61 187--70 187--92 187--115 187--119 187--182 187--186 188 studentLocatorResult 188--0 188--1 188--5 188--187 189 studentLocatorResults 189--188

Download: .dot .svg .png

Table

Name Mandatory Characteristics Type Description XPath
@refId * g​Ref​Id​Type ​/studentLocatorResults​/studentLocatorResult​/@refId
studentLocatorResult any ​/studentLocatorResults​/studentLocatorResult
matchConfidence * M string A scoring value that indicates the provider's level of confidence that the this result matches the query. ​/studentLocatorResults​/studentLocatorResult​/matchConfidence
rel * token ​/studentLocatorResults​/studentLocatorResult​/links​/link​/rel
href * token ​/studentLocatorResults​/studentLocatorResult​/links​/link​/href
@refId g​Ref​Id​Type ​/studentLocatorResults​/studentLocatorResult​/student​/@refId
student any ​/studentLocatorResults​/studentLocatorResult​/student
type O x​Person​Name​Type​Type The types of previous, alternate or other names for a person. Generally the "LegalName" for the primary name. ​/studentLocatorResults​/studentLocatorResult​/student​/name​/type
prefix O token An appellation, if any, used to denote rank, placement, or status (e.g., Mr., Ms., Reverend, Sister, Dr., Colonel). ​/studentLocatorResults​/studentLocatorResult​/student​/name​/prefix
familyName O normalized​String The full legal last name borne in common by members of a family. ​/studentLocatorResults​/studentLocatorResult​/student​/name​/familyName
givenName O normalized​String The full legal first name given to a person at birth, baptism, or through legal change. ​/studentLocatorResults​/studentLocatorResult​/student​/name​/givenName
middleName O normalized​String A full legal middle name given to a person at birth, baptism, or through legal change. ​/studentLocatorResults​/studentLocatorResult​/student​/name​/middleName
suffix O normalized​String An appendage, if any, used to denote a person's generation in his family (e.g., Jr., Sr., III). ​/studentLocatorResults​/studentLocatorResult​/student​/name​/suffix
type O x​Person​Name​Type​Type The types of previous, alternate or other names for a person. Generally the "LegalName" for the primary name. ​/studentLocatorResults​/studentLocatorResult​/student​/otherNames​/name​/type
prefix O token An appellation, if any, used to denote rank, placement, or status (e.g., Mr., Ms., Reverend, Sister, Dr., Colonel). ​/studentLocatorResults​/studentLocatorResult​/student​/otherNames​/name​/prefix
familyName O normalized​String The full legal last name borne in common by members of a family. ​/studentLocatorResults​/studentLocatorResult​/student​/otherNames​/name​/familyName
givenName O normalized​String The full legal first name given to a person at birth, baptism, or through legal change. ​/studentLocatorResults​/studentLocatorResult​/student​/otherNames​/name​/givenName
middleName O normalized​String A full legal middle name given to a person at birth, baptism, or through legal change. ​/studentLocatorResults​/studentLocatorResult​/student​/otherNames​/name​/middleName
suffix O normalized​String An appendage, if any, used to denote a person's generation in his family (e.g., Jr., Sr., III). ​/studentLocatorResults​/studentLocatorResult​/student​/otherNames​/name​/suffix
localId Q x​Person​Id​Type A unique number or alphanumeric code assigned to a staff member by a district or LEA. ​/studentLocatorResults​/studentLocatorResult​/student​/localId
loginId Q x​Login​Id​Type The login identifier for the person. ​/studentLocatorResults​/studentLocatorResult​/student​/loginId
stateProvinceId O x​Person​Id​Type A unique number or alphanumeric code assigned to a student by a state. ​/studentLocatorResults​/studentLocatorResult​/student​/stateProvinceId
type O x​Person​Id​System​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. ​/studentLocatorResults​/studentLocatorResult​/student​/otherIds​/otherId​/type
id * M x​Person​Id​Type A unique number or alphanumeric code assigned to a student by a school, school system, a state, or other agency or entity. ​/studentLocatorResults​/studentLocatorResult​/student​/otherIds​/otherId​/id
addressType O x​Address​Type​For​Learner​Or​Family​Type The type of address listed for a learner or a parent, guardian, family member or related person. ​/studentLocatorResults​/studentLocatorResult​/student​/address​/addressType
line1 O normalized​String The first line of the address. ​/studentLocatorResults​/studentLocatorResult​/student​/address​/line1
line2 O normalized​String The second line of the address. ​/studentLocatorResults​/studentLocatorResult​/student​/address​/line2
city O normalized​String The name of the city in which an address is located. ​/studentLocatorResults​/studentLocatorResult​/student​/address​/city
stateProvince O x​State​Code​USType The abbreviation for the state, province or outlying area in which an address is located. ​/studentLocatorResults​/studentLocatorResult​/student​/address​/stateProvince
countryCode O x​Country​Code​Type The unique two character International Organization for Standardization (ISO) code for the country in which an address is located. ​/studentLocatorResults​/studentLocatorResult​/student​/address​/countryCode
postalCode O normalized​String A number that identifies each postal delivery area in the locale used as a portion of an address. ​/studentLocatorResults​/studentLocatorResult​/student​/address​/postalCode
addressType O x​Address​Type​For​Learner​Or​Family​Type The type of address listed for a learner or a parent, guardian, family member or related person. ​/studentLocatorResults​/studentLocatorResult​/student​/otherAddresses​/name​/addressType
line1 O normalized​String The first line of the address. ​/studentLocatorResults​/studentLocatorResult​/student​/otherAddresses​/name​/line1
line2 O normalized​String The second line of the address. ​/studentLocatorResults​/studentLocatorResult​/student​/otherAddresses​/name​/line2
city O normalized​String The name of the city in which an address is located. ​/studentLocatorResults​/studentLocatorResult​/student​/otherAddresses​/name​/city
stateProvince O x​State​Code​USType The abbreviation for the state, province or outlying area in which an address is located. ​/studentLocatorResults​/studentLocatorResult​/student​/otherAddresses​/name​/stateProvince
countryCode O x​Country​Code​Type The unique two character International Organization for Standardization (ISO) code for the country in which an address is located. ​/studentLocatorResults​/studentLocatorResult​/student​/otherAddresses​/name​/countryCode
postalCode O normalized​String A number that identifies each postal delivery area in the locale used as a portion of an address. ​/studentLocatorResults​/studentLocatorResult​/student​/otherAddresses​/name​/postalCode
phoneNumberType O x​Telephone​Type​Type The type of communication number listed for a person. ​/studentLocatorResults​/studentLocatorResult​/student​/phoneNumber​/phoneNumberType
number * M token The telephone number including the area code, and extension, if applicable. ​/studentLocatorResults​/studentLocatorResult​/student​/phoneNumber​/number
primaryIndicator O boolean An indication that the telephone number should be used as the principal number for a person or organization. ​/studentLocatorResults​/studentLocatorResult​/student​/phoneNumber​/primaryIndicator
phoneNumberType O x​Telephone​Type​Type The type of communication number listed for a person. ​/studentLocatorResults​/studentLocatorResult​/student​/otherPhoneNumbers​/phoneNumber​/phoneNumberType
number * M token The telephone number including the area code, and extension, if applicable. ​/studentLocatorResults​/studentLocatorResult​/student​/otherPhoneNumbers​/phoneNumber​/number
primaryIndicator O boolean An indication that the telephone number should be used as the principal number for a person or organization. ​/studentLocatorResults​/studentLocatorResult​/student​/otherPhoneNumbers​/phoneNumber​/primaryIndicator
emailType O x​Email​Type​Type The type of electronic mail (e-mail) address listed for a person or organization. ​/studentLocatorResults​/studentLocatorResult​/student​/email​/emailType
emailAddress * M token The numbers, letters, and symbols used to identify an electronic mail (e-mail) user within the network to which the person or organization belongs. ​/studentLocatorResults​/studentLocatorResult​/student​/email​/emailAddress
emailType O x​Email​Type​Type The type of electronic mail (e-mail) address listed for a person or organization. ​/studentLocatorResults​/studentLocatorResult​/student​/otherEmails​/email​/emailType
emailAddress * M token The numbers, letters, and symbols used to identify an electronic mail (e-mail) user within the network to which the person or organization belongs. ​/studentLocatorResults​/studentLocatorResult​/student​/otherEmails​/email​/emailAddress
race * M x​Race​Type​Type Indicates the racial origins of a person. The possible values are: AmericanIndianOrAlaskaNative, Asian, BlackOrAfricanAmerican, NativeHawaiianOrOtherPacificIslander, White, DemographicRaceTwoOrMoreRaces. ​/studentLocatorResults​/studentLocatorResult​/student​/demographics​/races​/race​/race
hispanicLatinoEthnicity O boolean 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. ​/studentLocatorResults​/studentLocatorResult​/student​/demographics​/hispanicLatinoEthnicity
sex O x​Sex​Type The concept describing the biological traits that distinguish the males and females of a species. ​/studentLocatorResults​/studentLocatorResult​/student​/demographics​/sex
birthDate O date The year, month and day on which a person was born. ​/studentLocatorResults​/studentLocatorResult​/student​/demographics​/birthDate
countryOfBirth x​Country​Code​Type ​/studentLocatorResults​/studentLocatorResult​/student​/demographics​/countryOfBirth
usCitizenshipStatus O g​Citizenship​Status​Type An indicator of whether or not the person is a US citizen. ​/studentLocatorResults​/studentLocatorResult​/student​/demographics​/usCitizenshipStatus
demographics O any Demographic information about the student. ​/studentLocatorResults​/studentLocatorResult​/student​/demographics
leaRefId * M g​Ref​Id​Pointer​Type RefId of the LEA ​/studentLocatorResults​/studentLocatorResult​/student​/enrollment​/leaRefId
schoolRefId * M g​Ref​Id​Pointer​Type RefId of the school. ​/studentLocatorResults​/studentLocatorResult​/student​/enrollment​/schoolRefId
studentSchoolAssociationRefId O g​Ref​Id​Pointer​Type RefId of the SIF Student-School Association object. ​/studentLocatorResults​/studentLocatorResult​/student​/enrollment​/studentSchoolAssociationRefId
responsibleSchoolType O x​Responsible​School​Type​Type The type of services/instruction the school is responsible for providing to the student. ​/studentLocatorResults​/studentLocatorResult​/student​/enrollment​/responsibleSchoolType
membershipType O x​Membership​Type​Type The student's type of membership in the system. ​/studentLocatorResults​/studentLocatorResult​/student​/enrollment​/membershipType
entryDate * M date 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. ​/studentLocatorResults​/studentLocatorResult​/student​/enrollment​/entryDate
exitDate O date The year, month and day on which the student officially withdrew or graduated, i.e. the date on which the student's enrollment ended. ​/studentLocatorResults​/studentLocatorResult​/student​/enrollment​/exitDate
exitOrWithdrawalType O token The circumstances under which the student exited from membership in an educational institution. ​/studentLocatorResults​/studentLocatorResult​/student​/enrollment​/exitOrWithdrawalType
homeRoomNumber O token Home Room number ​/studentLocatorResults​/studentLocatorResult​/student​/enrollment​/homeRoomNumber
refId * M g​Ref​Id​Pointer​Type A SIF RefId. ​/studentLocatorResults​/studentLocatorResult​/student​/enrollment​/homeRoomTeacher​/refId
localId O x​Person​Id​Type ​/studentLocatorResults​/studentLocatorResult​/student​/enrollment​/homeRoomTeacher​/localId
givenName O normalized​String The full legal first name given to a person at birth, baptism, or through legal change. ​/studentLocatorResults​/studentLocatorResult​/student​/enrollment​/homeRoomTeacher​/givenName
familyName O normalized​String The full legal last name borne in common by members of a family. ​/studentLocatorResults​/studentLocatorResult​/student​/enrollment​/homeRoomTeacher​/familyName
gradeLevel O x​Grade​Level​Type The current grade or academic level of the student within a school. ​/studentLocatorResults​/studentLocatorResult​/student​/enrollment​/gradeLevel
projectedGraduationYear O g​Year The year and month the student is projected to graduate. ​/studentLocatorResults​/studentLocatorResult​/student​/enrollment​/projectedGraduationYear
refId * M g​Ref​Id​Pointer​Type A SIF RefId. ​/studentLocatorResults​/studentLocatorResult​/student​/enrollment​/counselor​/refId
localId O x​Person​Id​Type ​/studentLocatorResults​/studentLocatorResult​/student​/enrollment​/counselor​/localId
givenName O normalized​String The full legal first name given to a person at birth, baptism, or through legal change. ​/studentLocatorResults​/studentLocatorResult​/student​/enrollment​/counselor​/givenName
familyName O normalized​String The full legal last name borne in common by members of a family. ​/studentLocatorResults​/studentLocatorResult​/student​/enrollment​/counselor​/familyName
enrollment O any Current enrollment information for the student. ​/studentLocatorResults​/studentLocatorResult​/student​/enrollment
leaRefId * M g​Ref​Id​Pointer​Type RefId of the LEA ​/studentLocatorResults​/studentLocatorResult​/student​/otherEnrollments​/enrollment​/leaRefId
schoolRefId * M g​Ref​Id​Pointer​Type RefId of the school. ​/studentLocatorResults​/studentLocatorResult​/student​/otherEnrollments​/enrollment​/schoolRefId
studentSchoolAssociationRefId O g​Ref​Id​Pointer​Type RefId of the SIF Student-School Association object. ​/studentLocatorResults​/studentLocatorResult​/student​/otherEnrollments​/enrollment​/studentSchoolAssociationRefId
responsibleSchoolType O x​Responsible​School​Type​Type The type of services/instruction the school is responsible for providing to the student. ​/studentLocatorResults​/studentLocatorResult​/student​/otherEnrollments​/enrollment​/responsibleSchoolType
membershipType O x​Membership​Type​Type The student's type of membership in the system. ​/studentLocatorResults​/studentLocatorResult​/student​/otherEnrollments​/enrollment​/membershipType
entryDate * M date 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. ​/studentLocatorResults​/studentLocatorResult​/student​/otherEnrollments​/enrollment​/entryDate
exitDate O date The year, month and day on which the student officially withdrew or graduated, i.e. the date on which the student's enrollment ended. ​/studentLocatorResults​/studentLocatorResult​/student​/otherEnrollments​/enrollment​/exitDate
exitOrWithdrawalType O token The circumstances under which the student exited from membership in an educational institution. ​/studentLocatorResults​/studentLocatorResult​/student​/otherEnrollments​/enrollment​/exitOrWithdrawalType
homeRoomNumber O token Home Room number ​/studentLocatorResults​/studentLocatorResult​/student​/otherEnrollments​/enrollment​/homeRoomNumber
refId * M g​Ref​Id​Pointer​Type A SIF RefId. ​/studentLocatorResults​/studentLocatorResult​/student​/otherEnrollments​/enrollment​/homeRoomTeacher​/refId
localId O x​Person​Id​Type ​/studentLocatorResults​/studentLocatorResult​/student​/otherEnrollments​/enrollment​/homeRoomTeacher​/localId
givenName O normalized​String The full legal first name given to a person at birth, baptism, or through legal change. ​/studentLocatorResults​/studentLocatorResult​/student​/otherEnrollments​/enrollment​/homeRoomTeacher​/givenName
familyName O normalized​String The full legal last name borne in common by members of a family. ​/studentLocatorResults​/studentLocatorResult​/student​/otherEnrollments​/enrollment​/homeRoomTeacher​/familyName
gradeLevel O x​Grade​Level​Type The current grade or academic level of the student within a school. ​/studentLocatorResults​/studentLocatorResult​/student​/otherEnrollments​/enrollment​/gradeLevel
projectedGraduationYear O g​Year The year and month the student is projected to graduate. ​/studentLocatorResults​/studentLocatorResult​/student​/otherEnrollments​/enrollment​/projectedGraduationYear
refId * M g​Ref​Id​Pointer​Type A SIF RefId. ​/studentLocatorResults​/studentLocatorResult​/student​/otherEnrollments​/enrollment​/counselor​/refId
localId O x​Person​Id​Type ​/studentLocatorResults​/studentLocatorResult​/student​/otherEnrollments​/enrollment​/counselor​/localId
givenName O normalized​String The full legal first name given to a person at birth, baptism, or through legal change. ​/studentLocatorResults​/studentLocatorResult​/student​/otherEnrollments​/enrollment​/counselor​/givenName
familyName O normalized​String The full legal last name borne in common by members of a family. ​/studentLocatorResults​/studentLocatorResult​/student​/otherEnrollments​/enrollment​/counselor​/familyName
enrollment O any Enrollment information for the student. ​/studentLocatorResults​/studentLocatorResult​/student​/otherEnrollments​/enrollment
cumulativeWeightedGpa O decimal 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. ​/studentLocatorResults​/studentLocatorResult​/student​/academicSummary​/cumulativeWeightedGpa
termWeightedGpa O decimal 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. ​/studentLocatorResults​/studentLocatorResult​/student​/academicSummary​/termWeightedGpa
classRank O integer 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. ​/studentLocatorResults​/studentLocatorResult​/student​/academicSummary​/classRank
academicSummary O any Summary academic information for the student. ​/studentLocatorResults​/studentLocatorResult​/student​/academicSummary
contactPersonRefId O g​Ref​Id​Pointer​Type The RefId of the contact object. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/contactPersonRefId
@refId * g​Ref​Id​Type ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/@refId
xContact O any A person associated with a student. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact
type O x​Person​Name​Type​Type The types of previous, alternate or other names for a person. Generally the "LegalName" for the primary name. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/name​/type
prefix O token An appellation, if any, used to denote rank, placement, or status (e.g., Mr., Ms., Reverend, Sister, Dr., Colonel). ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/name​/prefix
familyName O normalized​String The full legal last name borne in common by members of a family. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/name​/familyName
givenName O normalized​String The full legal first name given to a person at birth, baptism, or through legal change. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/name​/givenName
middleName O normalized​String A full legal middle name given to a person at birth, baptism, or through legal change. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/name​/middleName
suffix O normalized​String An appendage, if any, used to denote a person's generation in his family (e.g., Jr., Sr., III). ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/name​/suffix
type O x​Person​Name​Type​Type The types of previous, alternate or other names for a person. Generally the "LegalName" for the primary name. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/otherNames​/name​/type
prefix O token An appellation, if any, used to denote rank, placement, or status (e.g., Mr., Ms., Reverend, Sister, Dr., Colonel). ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/otherNames​/name​/prefix
familyName O normalized​String The full legal last name borne in common by members of a family. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/otherNames​/name​/familyName
givenName O normalized​String The full legal first name given to a person at birth, baptism, or through legal change. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/otherNames​/name​/givenName
middleName O normalized​String A full legal middle name given to a person at birth, baptism, or through legal change. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/otherNames​/name​/middleName
suffix O normalized​String An appendage, if any, used to denote a person's generation in his family (e.g., Jr., Sr., III). ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/otherNames​/name​/suffix
localId O x​Person​Id​Type A unique number or alphanumeric code assigned to a staff member by a district or LEA. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/localId
loginId O x​Login​Id​Type The login identifier for the person. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/loginId
type O x​Person​Id​System​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. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/otherIds​/otherId​/type
id * M x​Person​Id​Type A unique number or alphanumeric code assigned to a student by a school, school system, a state, or other agency or entity. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/otherIds​/otherId​/id
addressType O x​Address​Type​For​Learner​Or​Family​Type The type of address listed for a learner or a parent, guardian, family member or related person. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/address​/addressType
line1 O normalized​String The first line of the address. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/address​/line1
line2 O normalized​String The second line of the address. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/address​/line2
city O normalized​String The name of the city in which an address is located. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/address​/city
stateProvince O x​State​Code​USType The abbreviation for the state, province or outlying area in which an address is located. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/address​/stateProvince
countryCode O x​Country​Code​Type The unique two character International Organization for Standardization (ISO) code for the country in which an address is located. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/address​/countryCode
postalCode O normalized​String A number that identifies each postal delivery area in the locale used as a portion of an address. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/address​/postalCode
phoneNumberType O x​Telephone​Type​Type The type of communication number listed for a person. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/phoneNumber​/phoneNumberType
number * M token The telephone number including the area code, and extension, if applicable. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/phoneNumber​/number
primaryIndicator O boolean An indication that the telephone number should be used as the principal number for a person or organization. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/phoneNumber​/primaryIndicator
phoneNumberType O x​Telephone​Type​Type The type of communication number listed for a person. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/otherPhoneNumbers​/phoneNumber​/phoneNumberType
number * M token The telephone number including the area code, and extension, if applicable. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/otherPhoneNumbers​/phoneNumber​/number
primaryIndicator O boolean An indication that the telephone number should be used as the principal number for a person or organization. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/otherPhoneNumbers​/phoneNumber​/primaryIndicator
emailType O x​Email​Type​Type The type of electronic mail (e-mail) address listed for a person or organization. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/email​/emailType
emailAddress * M token The numbers, letters, and symbols used to identify an electronic mail (e-mail) user within the network to which the person or organization belongs. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/email​/emailAddress
emailType O x​Email​Type​Type The type of electronic mail (e-mail) address listed for a person or organization. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/otherEmails​/email​/emailType
emailAddress * M token The numbers, letters, and symbols used to identify an electronic mail (e-mail) user within the network to which the person or organization belongs. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/otherEmails​/email​/emailAddress
sex O x​Sex​Type The concept describing the biological traits that distinguish the males and females of a species. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/sex
employerType O x​Employer​Type A code that defines the employer type. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/employerType
studentRefId * M g​Ref​Id​Pointer​Type ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/relationships​/relationship​/studentRefId
relationshipCode O x​Person​Relationship​To​Learner​Type ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/relationships​/relationship​/relationshipCode
restrictions O string Restrictions for student and/or teacher contact with the individual (e.g., the student may not be picked up by the individual. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/relationships​/relationship​/restrictions
livesWith O boolean Indicates whether or not the learner lives with the related person. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/relationships​/relationship​/livesWith
primaryContactIndicator O boolean 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. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/relationships​/relationship​/primaryContactIndicator
emergencyContactIndicator O boolean Indicates whether or not the person is a designated emergency contact for the learner. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/relationships​/relationship​/emergencyContactIndicator
financialResponsibilityIndicator O boolean ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/relationships​/relationship​/financialResponsibilityIndicator
custodialIndicator O boolean ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/relationships​/relationship​/custodialIndicator
communicationsIndicator O boolean ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/relationships​/relationship​/communicationsIndicator
contactSequence O integer The numeric order in the preferred sequence and priority for contacting a person related to the learner. ​/studentLocatorResults​/studentLocatorResult​/student​/studentContacts​/xContact​/relationships​/relationship​/contactSequence
type O x​Language​Type​Type An indication of the function and context in which a person uses a language to communicate. ​/studentLocatorResults​/studentLocatorResult​/student​/languages​/language​/type
code O x​Language​Code​Type The code for the specific language or dialect that a person uses to communicate. ​/studentLocatorResults​/studentLocatorResult​/student​/languages​/language​/code

Download: .xlsx (with CEDS & Formats)

Structure

<studentLocatorResults xmlns="http://www.sifassociation.org/datamodel/na/3.5"> <studentLocatorResult refId=""> <matchConfidence/> <links> <link> <rel/> <href/> </link> <link> <rel/> <href/> </link> </links> <student refId=""> <name> <type/> <prefix/> <familyName/> <givenName/> <middleName/> <suffix/> </name> <otherNames> <name> <type/> <prefix/> <familyName/> <givenName/> <middleName/> <suffix/> </name> <name> <type/> <prefix/> <familyName/> <givenName/> <middleName/> <suffix/> </name> </otherNames> <localId/> <loginId/> <stateProvinceId/> <otherIds> <otherId> <type/> <id/> </otherId> <otherId> <type/> <id/> </otherId> </otherIds> <address> <addressType/> <line1/> <line2/> <city/> <stateProvince/> <countryCode/> <postalCode/> </address> <otherAddresses> <name> <addressType/> <line1/> <line2/> <city/> <stateProvince/> <countryCode/> <postalCode/> </name> <name> <addressType/> <line1/> <line2/> <city/> <stateProvince/> <countryCode/> <postalCode/> </name> </otherAddresses> <phoneNumber> <phoneNumberType/> <number/> <primaryIndicator/> </phoneNumber> <otherPhoneNumbers> <phoneNumber> <phoneNumberType/> <number/> <primaryIndicator/> </phoneNumber> <phoneNumber> <phoneNumberType/> <number/> <primaryIndicator/> </phoneNumber> </otherPhoneNumbers> <email> <emailType/> <emailAddress/> </email> <otherEmails> <email> <emailType/> <emailAddress/> </email> <email> <emailType/> <emailAddress/> </email> </otherEmails> <demographics> <races> <race> <race/> </race> <race> <race/> </race> </races> <hispanicLatinoEthnicity/> <sex/> <birthDate/> <countryOfBirth/> <usCitizenshipStatus/> </demographics> <enrollment> <leaRefId/> <schoolRefId/> <studentSchoolAssociationRefId/> <responsibleSchoolType/> <membershipType/> <entryDate/> <exitDate/> <exitOrWithdrawalType/> <homeRoomNumber/> <homeRoomTeacher> <refId/> <localId/> <givenName/> <familyName/> </homeRoomTeacher> <gradeLevel/> <projectedGraduationYear/> <counselor> <refId/> <localId/> <givenName/> <familyName/> </counselor> </enrollment> <otherEnrollments> <enrollment> <leaRefId/> <schoolRefId/> <studentSchoolAssociationRefId/> <responsibleSchoolType/> <membershipType/> <entryDate/> <exitDate/> <exitOrWithdrawalType/> <homeRoomNumber/> <homeRoomTeacher> <refId/> <localId/> <givenName/> <familyName/> </homeRoomTeacher> <gradeLevel/> <projectedGraduationYear/> <counselor> <refId/> <localId/> <givenName/> <familyName/> </counselor> </enrollment> <enrollment> <leaRefId/> <schoolRefId/> <studentSchoolAssociationRefId/> <responsibleSchoolType/> <membershipType/> <entryDate/> <exitDate/> <exitOrWithdrawalType/> <homeRoomNumber/> <homeRoomTeacher> <refId/> <localId/> <givenName/> <familyName/> </homeRoomTeacher> <gradeLevel/> <projectedGraduationYear/> <counselor> <refId/> <localId/> <givenName/> <familyName/> </counselor> </enrollment> </otherEnrollments> <academicSummary> <cumulativeWeightedGpa/> <termWeightedGpa/> <classRank/> </academicSummary> <studentContacts> <contactPersonRefId/> <contactPersonRefId/> <xContact refId=""> <name> <type/> <prefix/> <familyName/> <givenName/> <middleName/> <suffix/> </name> <otherNames> <name> <type/> <prefix/> <familyName/> <givenName/> <middleName/> <suffix/> </name> <name> <type/> <prefix/> <familyName/> <givenName/> <middleName/> <suffix/> </name> </otherNames> <localId/> <loginId/> <otherIds> <otherId> <type/> <id/> </otherId> <otherId> <type/> <id/> </otherId> </otherIds> <address> <addressType/> <line1/> <line2/> <city/> <stateProvince/> <countryCode/> <postalCode/> </address> <phoneNumber> <phoneNumberType/> <number/> <primaryIndicator/> </phoneNumber> <otherPhoneNumbers> <phoneNumber> <phoneNumberType/> <number/> <primaryIndicator/> </phoneNumber> <phoneNumber> <phoneNumberType/> <number/> <primaryIndicator/> </phoneNumber> </otherPhoneNumbers> <email> <emailType/> <emailAddress/> </email> <otherEmails> <email> <emailType/> <emailAddress/> </email> <email> <emailType/> <emailAddress/> </email> </otherEmails> <sex/> <employerType/> <relationships> <relationship> <studentRefId/> <relationshipCode/> <restrictions/> <livesWith/> <primaryContactIndicator/> <emergencyContactIndicator/> <financialResponsibilityIndicator/> <custodialIndicator/> <communicationsIndicator/> <contactSequence/> </relationship> <relationship> <studentRefId/> <relationshipCode/> <restrictions/> <livesWith/> <primaryContactIndicator/> <emergencyContactIndicator/> <financialResponsibilityIndicator/> <custodialIndicator/> <communicationsIndicator/> <contactSequence/> </relationship> </relationships> </xContact> <xContact refId=""> <name> <type/> <prefix/> <familyName/> <givenName/> <middleName/> <suffix/> </name> <otherNames> <name> <type/> <prefix/> <familyName/> <givenName/> <middleName/> <suffix/> </name> <name> <type/> <prefix/> <familyName/> <givenName/> <middleName/> <suffix/> </name> </otherNames> <localId/> <loginId/> <otherIds> <otherId> <type/> <id/> </otherId> <otherId> <type/> <id/> </otherId> </otherIds> <address> <addressType/> <line1/> <line2/> <city/> <stateProvince/> <countryCode/> <postalCode/> </address> <phoneNumber> <phoneNumberType/> <number/> <primaryIndicator/> </phoneNumber> <otherPhoneNumbers> <phoneNumber> <phoneNumberType/> <number/> <primaryIndicator/> </phoneNumber> <phoneNumber> <phoneNumberType/> <number/> <primaryIndicator/> </phoneNumber> </otherPhoneNumbers> <email> <emailType/> <emailAddress/> </email> <otherEmails> <email> <emailType/> <emailAddress/> </email> <email> <emailType/> <emailAddress/> </email> </otherEmails> <sex/> <employerType/> <relationships> <relationship> <studentRefId/> <relationshipCode/> <restrictions/> <livesWith/> <primaryContactIndicator/> <emergencyContactIndicator/> <financialResponsibilityIndicator/> <custodialIndicator/> <communicationsIndicator/> <contactSequence/> </relationship> <relationship> <studentRefId/> <relationshipCode/> <restrictions/> <livesWith/> <primaryContactIndicator/> <emergencyContactIndicator/> <financialResponsibilityIndicator/> <custodialIndicator/> <communicationsIndicator/> <contactSequence/> </relationship> </relationships> </xContact> </studentContacts> <languages> <language> <type/> <code/> </language> <language> <type/> <code/> </language> </languages> </student> </studentLocatorResult> <studentLocatorResult refId=""> <matchConfidence/> <links> <link> <rel/> <href/> </link> <link> <rel/> <href/> </link> </links> <student refId=""> <name> <type/> <prefix/> <familyName/> <givenName/> <middleName/> <suffix/> </name> <otherNames> <name> <type/> <prefix/> <familyName/> <givenName/> <middleName/> <suffix/> </name> <name> <type/> <prefix/> <familyName/> <givenName/> <middleName/> <suffix/> </name> </otherNames> <localId/> <loginId/> <stateProvinceId/> <otherIds> <otherId> <type/> <id/> </otherId> <otherId> <type/> <id/> </otherId> </otherIds> <address> <addressType/> <line1/> <line2/> <city/> <stateProvince/> <countryCode/> <postalCode/> </address> <otherAddresses> <name> <addressType/> <line1/> <line2/> <city/> <stateProvince/> <countryCode/> <postalCode/> </name> <name> <addressType/> <line1/> <line2/> <city/> <stateProvince/> <countryCode/> <postalCode/> </name> </otherAddresses> <phoneNumber> <phoneNumberType/> <number/> <primaryIndicator/> </phoneNumber> <otherPhoneNumbers> <phoneNumber> <phoneNumberType/> <number/> <primaryIndicator/> </phoneNumber> <phoneNumber> <phoneNumberType/> <number/> <primaryIndicator/> </phoneNumber> </otherPhoneNumbers> <email> <emailType/> <emailAddress/> </email> <otherEmails> <email> <emailType/> <emailAddress/> </email> <email> <emailType/> <emailAddress/> </email> </otherEmails> <demographics> <races> <race> <race/> </race> <race> <race/> </race> </races> <hispanicLatinoEthnicity/> <sex/> <birthDate/> <countryOfBirth/> <usCitizenshipStatus/> </demographics> <enrollment> <leaRefId/> <schoolRefId/> <studentSchoolAssociationRefId/> <responsibleSchoolType/> <membershipType/> <entryDate/> <exitDate/> <exitOrWithdrawalType/> <homeRoomNumber/> <homeRoomTeacher> <refId/> <localId/> <givenName/> <familyName/> </homeRoomTeacher> <gradeLevel/> <projectedGraduationYear/> <counselor> <refId/> <localId/> <givenName/> <familyName/> </counselor> </enrollment> <otherEnrollments> <enrollment> <leaRefId/> <schoolRefId/> <studentSchoolAssociationRefId/> <responsibleSchoolType/> <membershipType/> <entryDate/> <exitDate/> <exitOrWithdrawalType/> <homeRoomNumber/> <homeRoomTeacher> <refId/> <localId/> <givenName/> <familyName/> </homeRoomTeacher> <gradeLevel/> <projectedGraduationYear/> <counselor> <refId/> <localId/> <givenName/> <familyName/> </counselor> </enrollment> <enrollment> <leaRefId/> <schoolRefId/> <studentSchoolAssociationRefId/> <responsibleSchoolType/> <membershipType/> <entryDate/> <exitDate/> <exitOrWithdrawalType/> <homeRoomNumber/> <homeRoomTeacher> <refId/> <localId/> <givenName/> <familyName/> </homeRoomTeacher> <gradeLevel/> <projectedGraduationYear/> <counselor> <refId/> <localId/> <givenName/> <familyName/> </counselor> </enrollment> </otherEnrollments> <academicSummary> <cumulativeWeightedGpa/> <termWeightedGpa/> <classRank/> </academicSummary> <studentContacts> <contactPersonRefId/> <contactPersonRefId/> <xContact refId=""> <name> <type/> <prefix/> <familyName/> <givenName/> <middleName/> <suffix/> </name> <otherNames> <name> <type/> <prefix/> <familyName/> <givenName/> <middleName/> <suffix/> </name> <name> <type/> <prefix/> <familyName/> <givenName/> <middleName/> <suffix/> </name> </otherNames> <localId/> <loginId/> <otherIds> <otherId> <type/> <id/> </otherId> <otherId> <type/> <id/> </otherId> </otherIds> <address> <addressType/> <line1/> <line2/> <city/> <stateProvince/> <countryCode/> <postalCode/> </address> <phoneNumber> <phoneNumberType/> <number/> <primaryIndicator/> </phoneNumber> <otherPhoneNumbers> <phoneNumber> <phoneNumberType/> <number/> <primaryIndicator/> </phoneNumber> <phoneNumber> <phoneNumberType/> <number/> <primaryIndicator/> </phoneNumber> </otherPhoneNumbers> <email> <emailType/> <emailAddress/> </email> <otherEmails> <email> <emailType/> <emailAddress/> </email> <email> <emailType/> <emailAddress/> </email> </otherEmails> <sex/> <employerType/> <relationships> <relationship> <studentRefId/> <relationshipCode/> <restrictions/> <livesWith/> <primaryContactIndicator/> <emergencyContactIndicator/> <financialResponsibilityIndicator/> <custodialIndicator/> <communicationsIndicator/> <contactSequence/> </relationship> <relationship> <studentRefId/> <relationshipCode/> <restrictions/> <livesWith/> <primaryContactIndicator/> <emergencyContactIndicator/> <financialResponsibilityIndicator/> <custodialIndicator/> <communicationsIndicator/> <contactSequence/> </relationship> </relationships> </xContact> <xContact refId=""> <name> <type/> <prefix/> <familyName/> <givenName/> <middleName/> <suffix/> </name> <otherNames> <name> <type/> <prefix/> <familyName/> <givenName/> <middleName/> <suffix/> </name> <name> <type/> <prefix/> <familyName/> <givenName/> <middleName/> <suffix/> </name> </otherNames> <localId/> <loginId/> <otherIds> <otherId> <type/> <id/> </otherId> <otherId> <type/> <id/> </otherId> </otherIds> <address> <addressType/> <line1/> <line2/> <city/> <stateProvince/> <countryCode/> <postalCode/> </address> <phoneNumber> <phoneNumberType/> <number/> <primaryIndicator/> </phoneNumber> <otherPhoneNumbers> <phoneNumber> <phoneNumberType/> <number/> <primaryIndicator/> </phoneNumber> <phoneNumber> <phoneNumberType/> <number/> <primaryIndicator/> </phoneNumber> </otherPhoneNumbers> <email> <emailType/> <emailAddress/> </email> <otherEmails> <email> <emailType/> <emailAddress/> </email> <email> <emailType/> <emailAddress/> </email> </otherEmails> <sex/> <employerType/> <relationships> <relationship> <studentRefId/> <relationshipCode/> <restrictions/> <livesWith/> <primaryContactIndicator/> <emergencyContactIndicator/> <financialResponsibilityIndicator/> <custodialIndicator/> <communicationsIndicator/> <contactSequence/> </relationship> <relationship> <studentRefId/> <relationshipCode/> <restrictions/> <livesWith/> <primaryContactIndicator/> <emergencyContactIndicator/> <financialResponsibilityIndicator/> <custodialIndicator/> <communicationsIndicator/> <contactSequence/> </relationship> </relationships> </xContact> </studentContacts> <languages> <language> <type/> <code/> </language> <language> <type/> <code/> </language> </languages> </student> </studentLocatorResult> </studentLocatorResults>

Download: .xml .json