sreInitializations
http://www.sifassociation.org/datamodel/na/3.5
Documentation
Stores the important initialization information pertaining to this SRE Job. This object is used by the Consumer in Phase 1 of an SRE Job to initialize the job record with relevant details.
Tree
Table
Name | Mandatory | Characteristics | Type | Description | XPath |
---|---|---|---|---|---|
@refId | * | gRefIdType | /sreInitializations/sreInitialization/@refId | ||
sreInitialization | any | /sreInitializations/sreInitialization | |||
@sif_Object | * | gObjectNameType | The name of the SIF object that is being referenced by the payload of this element. | /sreInitializations/sreInitialization/jobId/@sif_Object | |
jobId | * | M | gGenericRefIdPointerType | The Sif Infrastructure guid of the job that the sreInitialization belongs to, that is resolvable by the provider. | /sreInitializations/sreInitialization/jobId |
@codesetName | string | /sreInitializations/sreInitialization/requesterEmailAddress/emailType/@codesetName | |||
code | * | M | token | A valid e-mail address at the organization making the request. | /sreInitializations/sreInitialization/requesterEmailAddress/emailType/code |
hexValue | string | As of version 3.4 hex values are not published with the code sets. | /sreInitializations/sreInitialization/requesterEmailAddress/emailType/hexValue | ||
hexValueDashed | string | This element is deprecated as of version 3.3 and should not be used. | /sreInitializations/sreInitialization/requesterEmailAddress/emailType/hexValueDashed | ||
@codesetName | string | /sreInitializations/sreInitialization/requesterEmailAddress/emailType/otherCodeList/otherCode/@codesetName | |||
otherCode | string | /sreInitializations/sreInitialization/requesterEmailAddress/emailType/otherCodeList/otherCode | |||
emailAddress | * | token | /sreInitializations/sreInitialization/requesterEmailAddress/emailAddress | ||
@sif_Object | * | gObjectNameType | The name of the SIF object that is being referenced by the payload of this element. | /sreInitializations/sreInitialization/requesterOrganizationRefId/@sif_Object | |
requesterOrganizationRefId | * | M | gGenericRefIdPointerType | The refId of the organization (LEA, School or SEA) responsible for the request that is resolvable by the provider. In order to support this field, the SRE provider must offer up all the organization-type endpoints outside of the functional service so that the organization information can be resolved. | /sreInitializations/sreInitialization/requesterOrganizationRefId |
@codesetName | string | /sreInitializations/sreInitialization/providerEmailAddress/emailType/@codesetName | |||
code | * | M | token | A valid e-mail address at the organization providing the records. | /sreInitializations/sreInitialization/providerEmailAddress/emailType/code |
hexValue | string | As of version 3.4 hex values are not published with the code sets. | /sreInitializations/sreInitialization/providerEmailAddress/emailType/hexValue | ||
hexValueDashed | string | This element is deprecated as of version 3.3 and should not be used. | /sreInitializations/sreInitialization/providerEmailAddress/emailType/hexValueDashed | ||
@codesetName | string | /sreInitializations/sreInitialization/providerEmailAddress/emailType/otherCodeList/otherCode/@codesetName | |||
otherCode | string | /sreInitializations/sreInitialization/providerEmailAddress/emailType/otherCodeList/otherCode | |||
emailAddress | * | token | /sreInitializations/sreInitialization/providerEmailAddress/emailAddress | ||
@sif_Object | * | gObjectNameType | The name of the SIF object that is being referenced by the payload of this element. | /sreInitializations/sreInitialization/providerOrganizationRefId/@sif_Object | |
providerOrganizationRefId | * | M | gGenericRefIdPointerType | The refId of the organization (LEA, School or SEA) responsible for providing the student records, that is resolvable by the provider. In order to support this field, the SRE provider must offer up all the organization-type endpoints outside of the functional service so that the organization information can be resolved. | /sreInitializations/sreInitialization/providerOrganizationRefId |
studentId | * | M | token | The ID of student whose records are being requested that is resolvable by the provider, which is a unique number or alphanumeric code assigned to a student by a school, school system, a state, or other agency or entity. | /sreInitializations/sreInitialization/studentId |
Download: .xlsx (with CEDS & Formats)
Structure