SIF Student Record Exchange API documentation

Phase 1: Job Object

Creating a new SRE Job begins the process of requesting a student's records, but does not immediately provide the records.

/sreJobs post

post

Submit a new SRE job for processing.

Request
Response

Query Parameters

ncesId

(integer)

The NCES ID of the school, district, or state from which the record will be provided. The NCES ID is provided by the Student Locator service. If not provided, the SRE Job will only be created in the scope of local records.

Example:

Body

Type: application/xml

Schema:

<!-- version 3.03.02 -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:include schemaLocation="../Entity/SIFglobal.xsd"/>
  <xs:complexType name="sreJobType">
    <xs:annotation>
      <xs:appinfo>
        <elementName>Student Record Exchange Job Type</elementName>
        <events>no</events>
        <isSIFObject>no</isSIFObject>
      </xs:appinfo>
      <xs:documentation>
        A Student Record Exchange (SRE) job tracks the status of moving a student's full student record from a SIF service provider. The process includes four basic phases: 1) Creating the job; 2) Requesting permission to obtain the record; 3) Fetching the record; 4) and Sending a receipt back to the responder. The Job object stores the metadata necessary for tracking this multi-phase process.
      </xs:documentation>
    </xs:annotation>
    <xs:complexContent>
      <xs:extension base="gSIF_FunctionalServiceType">
        <xs:sequence>
          <xs:element name="name" type="xs:token" minOccurs="1">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Job Name</elementName>
                <sifChar>M</sifChar>
                <cedsId/>
                <cedsURL/>
              </xs:appinfo>
              <xs:documentation>
                A human readable identifier for the job. Example: "John Smith Transfer 01-25-14".
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="requesterEmailAddress" type="gEmailType" minOccurs="1">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Requester Email Address</elementName>
                <sifChar>M</sifChar>
                <cedsId/>
                <cedsURL/>
              </xs:appinfo>
              <xs:documentation>
                A valid e-mail address at the organization making the request.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="requesterOrganizationRefId" type="gGenericRefIdPointerType" minOccurs="1">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Requester Organization RefId</elementName>
                <sifChar>M</sifChar>
              </xs:appinfo>
              <xs:documentation>
                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.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="providerEmailAddress" type="gEmailType" minOccurs="0">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Provider Email Address</elementName>
                <sifChar>O</sifChar>
                <cedsId/>
                <cedsURL/>
              </xs:appinfo>
              <xs:documentation>
                A valid e-mail address at the organization providing the records.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="providerOrganizationRefId" type="gGenericRefIdPointerType" minOccurs="1">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Provider Organization RefId</elementName>
                <sifChar>M</sifChar>
              </xs:appinfo>
              <xs:documentation>
                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.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="studentId" type="xs:token" minOccurs="1">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Student ID</elementName>
                <sifChar>M</sifChar>
                <cedsId>001071</cedsId>
                <cedsURL>
                  https://ceds.ed.gov/CEDSElementDetails.aspx?TermxTopicId=20775
                </cedsURL>
              </xs:appinfo>
              <xs:documentation>
                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.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="sreJob" type="sreJobType"/>
</xs:schema>

HTTP status code 201

Successfully created the job.

Body

Type: application/xml

Schema:

<!-- version 3.03.02 -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:include schemaLocation="../Entity/SIFglobal.xsd"/>
  <xs:complexType name="sreJobType">
    <xs:annotation>
      <xs:appinfo>
        <elementName>Student Record Exchange Job Type</elementName>
        <events>no</events>
        <isSIFObject>no</isSIFObject>
      </xs:appinfo>
      <xs:documentation>
        A Student Record Exchange (SRE) job tracks the status of moving a student's full student record from a SIF service provider. The process includes four basic phases: 1) Creating the job; 2) Requesting permission to obtain the record; 3) Fetching the record; 4) and Sending a receipt back to the responder. The Job object stores the metadata necessary for tracking this multi-phase process.
      </xs:documentation>
    </xs:annotation>
    <xs:complexContent>
      <xs:extension base="gSIF_FunctionalServiceType">
        <xs:sequence>
          <xs:element name="name" type="xs:token" minOccurs="1">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Job Name</elementName>
                <sifChar>M</sifChar>
                <cedsId/>
                <cedsURL/>
              </xs:appinfo>
              <xs:documentation>
                A human readable identifier for the job. Example: "John Smith Transfer 01-25-14".
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="requesterEmailAddress" type="gEmailType" minOccurs="1">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Requester Email Address</elementName>
                <sifChar>M</sifChar>
                <cedsId/>
                <cedsURL/>
              </xs:appinfo>
              <xs:documentation>
                A valid e-mail address at the organization making the request.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="requesterOrganizationRefId" type="gGenericRefIdPointerType" minOccurs="1">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Requester Organization RefId</elementName>
                <sifChar>M</sifChar>
              </xs:appinfo>
              <xs:documentation>
                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.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="providerEmailAddress" type="gEmailType" minOccurs="0">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Provider Email Address</elementName>
                <sifChar>O</sifChar>
                <cedsId/>
                <cedsURL/>
              </xs:appinfo>
              <xs:documentation>
                A valid e-mail address at the organization providing the records.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="providerOrganizationRefId" type="gGenericRefIdPointerType" minOccurs="1">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Provider Organization RefId</elementName>
                <sifChar>M</sifChar>
              </xs:appinfo>
              <xs:documentation>
                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.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="studentId" type="xs:token" minOccurs="1">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Student ID</elementName>
                <sifChar>M</sifChar>
                <cedsId>001071</cedsId>
                <cedsURL>
                  https://ceds.ed.gov/CEDSElementDetails.aspx?TermxTopicId=20775
                </cedsURL>
              </xs:appinfo>
              <xs:documentation>
                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.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="sreJob" type="sreJobType"/>
</xs:schema>

/sreJobs/{jobId} get delete

get

Get the details of a specific job, identified by {jobId}.

delete

Delete the job. This also deletes all child resources (permissionRequest, sre, receipt).

Get the details of a specific job, identified by {jobId}.

Request
Response

URI Parameters

jobId: required (string)

HTTP status code 200

Body

Type: application/xml

Schema:

<!-- version 3.03.02 -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:include schemaLocation="../Entity/SIFglobal.xsd"/>
  <xs:complexType name="sreJobType">
    <xs:annotation>
      <xs:appinfo>
        <elementName>Student Record Exchange Job Type</elementName>
        <events>no</events>
        <isSIFObject>no</isSIFObject>
      </xs:appinfo>
      <xs:documentation>
        A Student Record Exchange (SRE) job tracks the status of moving a student's full student record from a SIF service provider. The process includes four basic phases: 1) Creating the job; 2) Requesting permission to obtain the record; 3) Fetching the record; 4) and Sending a receipt back to the responder. The Job object stores the metadata necessary for tracking this multi-phase process.
      </xs:documentation>
    </xs:annotation>
    <xs:complexContent>
      <xs:extension base="gSIF_FunctionalServiceType">
        <xs:sequence>
          <xs:element name="name" type="xs:token" minOccurs="1">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Job Name</elementName>
                <sifChar>M</sifChar>
                <cedsId/>
                <cedsURL/>
              </xs:appinfo>
              <xs:documentation>
                A human readable identifier for the job. Example: "John Smith Transfer 01-25-14".
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="requesterEmailAddress" type="gEmailType" minOccurs="1">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Requester Email Address</elementName>
                <sifChar>M</sifChar>
                <cedsId/>
                <cedsURL/>
              </xs:appinfo>
              <xs:documentation>
                A valid e-mail address at the organization making the request.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="requesterOrganizationRefId" type="gGenericRefIdPointerType" minOccurs="1">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Requester Organization RefId</elementName>
                <sifChar>M</sifChar>
              </xs:appinfo>
              <xs:documentation>
                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.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="providerEmailAddress" type="gEmailType" minOccurs="0">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Provider Email Address</elementName>
                <sifChar>O</sifChar>
                <cedsId/>
                <cedsURL/>
              </xs:appinfo>
              <xs:documentation>
                A valid e-mail address at the organization providing the records.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="providerOrganizationRefId" type="gGenericRefIdPointerType" minOccurs="1">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Provider Organization RefId</elementName>
                <sifChar>M</sifChar>
              </xs:appinfo>
              <xs:documentation>
                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.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="studentId" type="xs:token" minOccurs="1">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Student ID</elementName>
                <sifChar>M</sifChar>
                <cedsId>001071</cedsId>
                <cedsURL>
                  https://ceds.ed.gov/CEDSElementDetails.aspx?TermxTopicId=20775
                </cedsURL>
              </xs:appinfo>
              <xs:documentation>
                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.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="sreJob" type="sreJobType"/>
</xs:schema>

Phase 2: Permission Request

Before a requester can access the sre object for a student, he must have obtained permission. This permission is tracked through this child resource called a "Permission Request", which contains details of the request, the status of the approval, and a token that is used to obtain the sre object in the next step. Because permission approvals will often require human intervention, these are always issued as a SIF delayed request.

/sreJobs/{jobId}/permissionRequests get post

get

Retrieves the list of permission requests.

post

Issues a new permission request. (Delayed response)

Retrieves the list of permission requests.

Request
Response

URI Parameters

jobId: required (string)

Query Parameters

isActive: (boolean)
Only return the request which is the primary, active permissionRequest. If left blank, all records are returned.

HTTP status code 200

Success

Body

Type: application/xml

Schema:

<!-- version 3.03.02 -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:include schemaLocation="../Entity/SIFglobal.xsd"/>
  <xs:complexType name="srePermissionRequestType">
    <xs:annotation>
      <xs:appinfo>
        <elementName>Student Record Exchange Permission Request Type</elementName>
        <events>no</events>
        <isSIFObject>no</isSIFObject>
      </xs:appinfo>
      <xs:documentation>
        Before a requester can access the sre object for a student, he must have obtained permission. This permission is tracked through this child resource called a "Permission Request", which contains details of the request, the status of the approval, and a token that is used to obtain the sre object in the next step. Because permission approvals will often require human intervention, these are always issued as a SIF delayed request.
        
        #TODO Need to add status to this object.
      </xs:documentation>
    </xs:annotation>
    <xs:complexContent>
      <xs:extension base="gSIF_FunctionalServiceType">
        <xs:sequence>
          <xs:element name="requesterComment" type="xs:string" minOccurs="0">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Requester Comment</elementName>
                <sifChar>O</sifChar>
                <cedsId/>
                <cedsURL/>
              </xs:appinfo>
              <xs:documentation>
                Human readable content provided by the requestor that helps clarify the purpose or scope of the request.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="xQuery" type="xs:string" minOccurs="0">
            <xs:annotation>
              <xs:appinfo>
                <elementName>xQuery</elementName>
                <sifChar>O</sifChar>
                <cedsId/>
                <cedsURL/>
              </xs:appinfo>
              <xs:documentation>
                Standard xQuery token. “Everything you have” is default. TODO: Need to define token schema
              </xs:documentation>
            </xs:annotation>
          </xs:element>
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="srePermissionRequest" type="srePermissionRequestType"/>
</xs:schema>

Issues a new permission request. (Delayed response)

Request
Response

URI Parameters

jobId: required (string)

Headers

queueId: (string)
The queue ID that can accept the delayed response. TODO move to SIF queueable trait.

Body

Type: application/xml

Schema:

<!-- version 3.03.02 -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:include schemaLocation="../Entity/SIFglobal.xsd"/>
  <xs:complexType name="srePermissionRequestType">
    <xs:annotation>
      <xs:appinfo>
        <elementName>Student Record Exchange Permission Request Type</elementName>
        <events>no</events>
        <isSIFObject>no</isSIFObject>
      </xs:appinfo>
      <xs:documentation>
        Before a requester can access the sre object for a student, he must have obtained permission. This permission is tracked through this child resource called a "Permission Request", which contains details of the request, the status of the approval, and a token that is used to obtain the sre object in the next step. Because permission approvals will often require human intervention, these are always issued as a SIF delayed request.
        
        #TODO Need to add status to this object.
      </xs:documentation>
    </xs:annotation>
    <xs:complexContent>
      <xs:extension base="gSIF_FunctionalServiceType">
        <xs:sequence>
          <xs:element name="requesterComment" type="xs:string" minOccurs="0">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Requester Comment</elementName>
                <sifChar>O</sifChar>
                <cedsId/>
                <cedsURL/>
              </xs:appinfo>
              <xs:documentation>
                Human readable content provided by the requestor that helps clarify the purpose or scope of the request.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="xQuery" type="xs:string" minOccurs="0">
            <xs:annotation>
              <xs:appinfo>
                <elementName>xQuery</elementName>
                <sifChar>O</sifChar>
                <cedsId/>
                <cedsURL/>
              </xs:appinfo>
              <xs:documentation>
                Standard xQuery token. “Everything you have” is default. TODO: Need to define token schema
              </xs:documentation>
            </xs:annotation>
          </xs:element>
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="srePermissionRequest" type="srePermissionRequestType"/>
</xs:schema>

HTTP status code 202

Delayed response accepted - TODO figure out how to specify text response

HTTP status code 600

The delayed response from the queue

Body

Type: application/xml

Schema:

<!-- version 3.03.02 -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:include schemaLocation="../Entity/SIFglobal.xsd"/>
  <xs:complexType name="srePermissionRequestType">
    <xs:annotation>
      <xs:appinfo>
        <elementName>Student Record Exchange Permission Request Type</elementName>
        <events>no</events>
        <isSIFObject>no</isSIFObject>
      </xs:appinfo>
      <xs:documentation>
        Before a requester can access the sre object for a student, he must have obtained permission. This permission is tracked through this child resource called a "Permission Request", which contains details of the request, the status of the approval, and a token that is used to obtain the sre object in the next step. Because permission approvals will often require human intervention, these are always issued as a SIF delayed request.
        
        #TODO Need to add status to this object.
      </xs:documentation>
    </xs:annotation>
    <xs:complexContent>
      <xs:extension base="gSIF_FunctionalServiceType">
        <xs:sequence>
          <xs:element name="requesterComment" type="xs:string" minOccurs="0">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Requester Comment</elementName>
                <sifChar>O</sifChar>
                <cedsId/>
                <cedsURL/>
              </xs:appinfo>
              <xs:documentation>
                Human readable content provided by the requestor that helps clarify the purpose or scope of the request.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="xQuery" type="xs:string" minOccurs="0">
            <xs:annotation>
              <xs:appinfo>
                <elementName>xQuery</elementName>
                <sifChar>O</sifChar>
                <cedsId/>
                <cedsURL/>
              </xs:appinfo>
              <xs:documentation>
                Standard xQuery token. “Everything you have” is default. TODO: Need to define token schema
              </xs:documentation>
            </xs:annotation>
          </xs:element>
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="srePermissionRequest" type="srePermissionRequestType"/>
</xs:schema>

/sreJobs/{jobId}/permissionRequests/{id} get

get

Fetches the details about the specified permission request.

Request
Response

URI Parameters

jobId: required (string)
id: required (string)

HTTP status code 200

Success

Body

Type: application/xml

Schema:

<!-- version 3.03.02 -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:include schemaLocation="../Entity/SIFglobal.xsd"/>
  <xs:complexType name="srePermissionRequestType">
    <xs:annotation>
      <xs:appinfo>
        <elementName>Student Record Exchange Permission Request Type</elementName>
        <events>no</events>
        <isSIFObject>no</isSIFObject>
      </xs:appinfo>
      <xs:documentation>
        Before a requester can access the sre object for a student, he must have obtained permission. This permission is tracked through this child resource called a "Permission Request", which contains details of the request, the status of the approval, and a token that is used to obtain the sre object in the next step. Because permission approvals will often require human intervention, these are always issued as a SIF delayed request.
        
        #TODO Need to add status to this object.
      </xs:documentation>
    </xs:annotation>
    <xs:complexContent>
      <xs:extension base="gSIF_FunctionalServiceType">
        <xs:sequence>
          <xs:element name="requesterComment" type="xs:string" minOccurs="0">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Requester Comment</elementName>
                <sifChar>O</sifChar>
                <cedsId/>
                <cedsURL/>
              </xs:appinfo>
              <xs:documentation>
                Human readable content provided by the requestor that helps clarify the purpose or scope of the request.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="xQuery" type="xs:string" minOccurs="0">
            <xs:annotation>
              <xs:appinfo>
                <elementName>xQuery</elementName>
                <sifChar>O</sifChar>
                <cedsId/>
                <cedsURL/>
              </xs:appinfo>
              <xs:documentation>
                Standard xQuery token. “Everything you have” is default. TODO: Need to define token schema
              </xs:documentation>
            </xs:annotation>
          </xs:element>
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="srePermissionRequest" type="srePermissionRequestType"/>
</xs:schema>

Phase 3: SRE Object

Once the consumer has proper permissions, this phase requests the actual student record object. The provider should check that the requestToken is valid before delivering the xSre object.

/sreJobs/{jobId}/xSre get

get

Get the object

Request
Response

URI Parameters

jobId: required (string)

Headers

xQuery: (string)
The values requested from the provider in the xSre object.
requestToken: (string)
The requestToken that authorizes access to this student record. Could have been retrieved from the permissionRequest object or received from an out-of-band process.

HTTP status code 200

Returns the xSre object.

Body

Type: application/xml

Schema:

<?xml version="1.0"?>
<!--version 3.03.01-->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:include schemaLocation="../SIFglobal.xsd"/>
  <xs:include schemaLocation="SIFNAxSreCommonTypes.xsd"/>
  <xs:include schemaLocation="../Composite/SIFNAxPress.xsd"/>
  <xs:complexType name="xSreType">
    <xs:annotation>
      <xs:appinfo>
        <elementName>xStudent Type</elementName>
        <events>yes</events>
        <isSIFObject>yes</isSIFObject>
        <cedsId/>
        <cedsURL/>
      </xs:appinfo>
      <xs:documentation>The Record Exchange object is a relatively de-normalized data structure meant to be used to transfer student information from one system to another. </xs:documentation>
    </xs:annotation>
    <xs:complexContent>
      <xs:extension base="xStudentType">
        <xs:sequence>
          <xs:element name="reportDate" type="xs:date">
            <xs:annotation>
              <xs:documentation>The date that this xSre object was generated.</xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="reportingLea" type="xLeaType" minOccurs="0">
            <xs:annotation>
              <xs:documentation>Information about the LEA that generated this xSre object, or if the object was generated by a different entity, the LEA that provided the information to populate this record.</xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="assessments" minOccurs="0">
            <xs:annotation>
              <xs:documentation>List of assessments for this student, including testing information, content area, and various scores.</xs:documentation>
            </xs:annotation>
            <xs:complexType>
              <xs:sequence>
                <xs:element name="assessment" type="xAssessmentType" minOccurs="0" maxOccurs="unbounded">
                  <xs:annotation>
                    <xs:appinfo>
                      <elementName/>
                      <sifChar>OR</sifChar>/>
                      <cedsId/>
                      <cedsURL/>
                    </xs:appinfo>
                    <xs:documentation/>
                  </xs:annotation>
                </xs:element>
              </xs:sequence>
            </xs:complexType>
          </xs:element>
          <xs:element name="attendance" minOccurs="0">
            <xs:annotation>
              <xs:documentation>Attendance information for the student, including summaries and lists of attendance events.</xs:documentation>
            </xs:annotation>
            <xs:complexType>
              <xs:sequence>
                <xs:element name="summaries" minOccurs="0">
                  <xs:annotation>
                    <xs:documentation>A list of attendance summaries for specific periods of time, with summary metrics about the student's attendnace during the time period.</xs:documentation>
                  </xs:annotation>
                  <xs:complexType>
                    <xs:sequence>
                      <xs:element name="summary" type="xAttendanceSummaryType" minOccurs="0" maxOccurs="unbounded"/>
                    </xs:sequence>
                  </xs:complexType>
                </xs:element>
                <xs:element name="events" minOccurs="0">
                  <xs:annotation>
                    <xs:documentation>A list of individual attendance events for the student, describing specific attendance or absence events.</xs:documentation>
                  </xs:annotation>
                  <xs:complexType>
                    <xs:sequence>
                      <xs:element name="event" type="xAttendanceEventType" minOccurs="0" maxOccurs="unbounded"/>
                    </xs:sequence>
                  </xs:complexType>
                </xs:element>
              </xs:sequence>
            </xs:complexType>
          </xs:element>
          <xs:element name="disciplineIncidents" minOccurs="0">
            <xs:annotation>
              <xs:documentation>List of all discipline incidents associated with this student.</xs:documentation>
            </xs:annotation>
            <xs:complexType>
              <xs:sequence>
                <xs:element name="disciplineIncident" type="xDisciplineIncidentType" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element>
          <xs:element name="transcriptTerm" type="xTranscriptTermType" minOccurs="0">
            <xs:annotation>
              <xs:documentation>Current term transcript information.</xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="otherTranscriptTerms" minOccurs="0">
            <xs:annotation>
              <xs:documentation>Past term transcript information.</xs:documentation>
            </xs:annotation>
            <xs:complexType>
              <xs:sequence>
                <xs:element name="transcriptTerm" type="xTranscriptTermType" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element>
          <xs:element name="competencies" minOccurs="0">
            <xs:annotation>
              <xs:documentation>A set of competencies that represent the student's completion or partial completion of a unit, course, program, degree, certification, or other achievement/award.</xs:documentation>
            </xs:annotation>
            <xs:complexType>
              <xs:sequence>
                <xs:element name="competency" type="xCompetencyType" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element>
          <xs:element name="health" type="xHealthType" minOccurs="0">
            <xs:annotation>
              <xs:documentation>Health-related information for the student, including immunizations and required tests.</xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="programs" type="xProgramSummaryType" minOccurs="0">
            <xs:annotation>
              <xs:documentation>Information about the student's participation in various state and federal programs.</xs:documentation>
            </xs:annotation>
          </xs:element>
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="xSre" type="xSreType"/>
</xs:schema>

Phase 4: Receipt

Notifies the provider of the status of the record request, with additional receipt codes that the provider may be able to act upon. For example, this object could report that a student has been sucessfully enrolled in a receiving school district.

/sreJobs/{jobId}/receipt post

post

Post a new receipt object to the provider.

Request
Response

URI Parameters

jobId: required (string)

Body

Type: text/xml

Schema:

<!-- version 3.03.02 -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:include schemaLocation="../Entity/SIFglobal.xsd"/>
  <xs:complexType name="sreReceiptType">
    <xs:annotation>
      <xs:appinfo>
        <elementName>Student Record Exchange Receipt Type</elementName>
        <events>no</events>
        <isSIFObject>no</isSIFObject>
      </xs:appinfo>
      <xs:documentation>
        Notifies the provider of the status of the record request, with additional receipt codes that the provider may be able to act upon. For example, this object could report that a student has been sucessfully enrolled in a receiving school district.
      </xs:documentation>
    </xs:annotation>
    <xs:complexContent>
      <xs:extension base="gSIF_FunctionalServiceType">
        <xs:sequence>
          <xs:element name="receiptDateTime" type="xs:dateTime" minOccurs="1">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Receipt Datetime</elementName>
                <sifChar>M</sifChar>
                <cedsId/>
                <cedsURL/>
              </xs:appinfo>
              <xs:documentation>
                Date and time that the record was received by the requester.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="receiverNCESSchoolCode" type="xs:token" minOccurs="0">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Receiving School NCES Code</elementName>
                <sifChar>O</sifChar>
                <cedsId>001069</cedsId>
                <cedsURL>
                  https://ceds.ed.gov/cedselementdetails.aspx?termid=3155
                </cedsURL>
              </xs:appinfo>
              <xs:documentation>
                The NCES Code is a unique number or alphanumeric code assigned to an institution by a school, school system, a state, or other agency or entity. In this context, this code represents the school that the student is being enrolled into, if this SRE Job is used to describe a student enrollment transfer.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="receivingNCESLEACode" type="xs:token" minOccurs="0">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Receiving LEA NCES Code</elementName>
                <sifChar>O</sifChar>
                <cedsId>001069</cedsId>
                <cedsURL>
                  https://ceds.ed.gov/cedselementdetails.aspx?termid=3155
                </cedsURL>
              </xs:appinfo>
              <xs:documentation>
                  The NCES Code is a unique number or alphanumeric code assigned to an institution by a school, school system, a state, or other agency or entity. In this context, this code represents the LEA that the student is being enrolled into, if this SRE Job is used to describe a student enrollment transfer.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="receiptCode" type="receiptCodeType" minOccurs="1">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Receipt Code</elementName>
                <sifChar>M</sifChar>
                <cedsId/>
                <cedsURL/>
              </xs:appinfo>
              <xs:documentation>
                A code that categorizes how the record was received and/or processed by the requesting organization.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="receiptComments" type="xs:normalizedString" minOccurs="0">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Receipt Comments</elementName>
                <sifChar>O</sifChar>
                <cedsId/>
                <cedsURL/>
              </xs:appinfo>
              <xs:documentation>
                Human-readable comments from the requester to the providing organization regarding actions taken during or after receipt of the student record. For example, a registrar may state here that the student has successfully enrolled in their school.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:simpleType name="receiptCodeType" final="restriction">
            <xs:restriction base="xs:token">
              <xs:enumeration value="enrollmentTransferComplete" />
              <xs:enumeration value="recordReceived" />
              <xs:enumeration value="recordRejectedOrIncomplete" />
              <xs:enumeration value="other" />
            </xs:restriction>
          </xs:simpleType>
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="sreReceipt" type="sreReceiptType"/>
</xs:schema>

HTTP status code 201

The receipt was delivered to the provider.

Body

Type: application/xml

Schema:

<!-- version 3.03.02 -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:include schemaLocation="../Entity/SIFglobal.xsd"/>
  <xs:complexType name="sreReceiptType">
    <xs:annotation>
      <xs:appinfo>
        <elementName>Student Record Exchange Receipt Type</elementName>
        <events>no</events>
        <isSIFObject>no</isSIFObject>
      </xs:appinfo>
      <xs:documentation>
        Notifies the provider of the status of the record request, with additional receipt codes that the provider may be able to act upon. For example, this object could report that a student has been sucessfully enrolled in a receiving school district.
      </xs:documentation>
    </xs:annotation>
    <xs:complexContent>
      <xs:extension base="gSIF_FunctionalServiceType">
        <xs:sequence>
          <xs:element name="receiptDateTime" type="xs:dateTime" minOccurs="1">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Receipt Datetime</elementName>
                <sifChar>M</sifChar>
                <cedsId/>
                <cedsURL/>
              </xs:appinfo>
              <xs:documentation>
                Date and time that the record was received by the requester.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="receiverNCESSchoolCode" type="xs:token" minOccurs="0">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Receiving School NCES Code</elementName>
                <sifChar>O</sifChar>
                <cedsId>001069</cedsId>
                <cedsURL>
                  https://ceds.ed.gov/cedselementdetails.aspx?termid=3155
                </cedsURL>
              </xs:appinfo>
              <xs:documentation>
                The NCES Code is a unique number or alphanumeric code assigned to an institution by a school, school system, a state, or other agency or entity. In this context, this code represents the school that the student is being enrolled into, if this SRE Job is used to describe a student enrollment transfer.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="receivingNCESLEACode" type="xs:token" minOccurs="0">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Receiving LEA NCES Code</elementName>
                <sifChar>O</sifChar>
                <cedsId>001069</cedsId>
                <cedsURL>
                  https://ceds.ed.gov/cedselementdetails.aspx?termid=3155
                </cedsURL>
              </xs:appinfo>
              <xs:documentation>
                  The NCES Code is a unique number or alphanumeric code assigned to an institution by a school, school system, a state, or other agency or entity. In this context, this code represents the LEA that the student is being enrolled into, if this SRE Job is used to describe a student enrollment transfer.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="receiptCode" type="receiptCodeType" minOccurs="1">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Receipt Code</elementName>
                <sifChar>M</sifChar>
                <cedsId/>
                <cedsURL/>
              </xs:appinfo>
              <xs:documentation>
                A code that categorizes how the record was received and/or processed by the requesting organization.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="receiptComments" type="xs:normalizedString" minOccurs="0">
            <xs:annotation>
              <xs:appinfo>
                <elementName>Receipt Comments</elementName>
                <sifChar>O</sifChar>
                <cedsId/>
                <cedsURL/>
              </xs:appinfo>
              <xs:documentation>
                Human-readable comments from the requester to the providing organization regarding actions taken during or after receipt of the student record. For example, a registrar may state here that the student has successfully enrolled in their school.
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:simpleType name="receiptCodeType" final="restriction">
            <xs:restriction base="xs:token">
              <xs:enumeration value="enrollmentTransferComplete" />
              <xs:enumeration value="recordReceived" />
              <xs:enumeration value="recordRejectedOrIncomplete" />
              <xs:enumeration value="other" />
            </xs:restriction>
          </xs:simpleType>
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="sreReceipt" type="sreReceiptType"/>
</xs:schema>

SIF Student Record Exchange API documentation version v3.3.1

Overview

Phase 1: Job Object

/sreJobs post

/sreJobs/{jobId} get delete

Phase 2: Permission Request

/sreJobs/{jobId}/permissionRequests get post

/sreJobs/{jobId}/permissionRequests/{id} get

Phase 3: SRE Object

/sreJobs/{jobId}/xSre get

Phase 4: Receipt

/sreJobs/{jobId}/receipt post

SIF Student Record Exchange API documentation version v3.3.1

Overview

Phase 1: Job Object

/sreJobs post

post /sreJobs

Query Parameters

Body

HTTP status code 201

Body

/sreJobs/{jobId} get delete

get /sreJobs/{jobId}

URI Parameters

HTTP status code 200

Body

delete /sreJobs/{jobId}

URI Parameters

HTTP status code 200

Phase 2: Permission Request

/sreJobs/{jobId}/permissionRequests get post

get /sreJobs/{jobId}/permissionRequests

URI Parameters

Query Parameters

HTTP status code 200

Body

post /sreJobs/{jobId}/permissionRequests

URI Parameters

Headers

Body

HTTP status code 202

HTTP status code 600

Body

/sreJobs/{jobId}/permissionRequests/{id} get

get /sreJobs/{jobId}/permissionRequests/{id}

URI Parameters

HTTP status code 200

Body

Phase 3: SRE Object

/sreJobs/{jobId}/xSre get

get /sreJobs/{jobId}/xSre

URI Parameters

Headers

HTTP status code 200

Body

Phase 4: Receipt

/sreJobs/{jobId}/receipt post

post /sreJobs/{jobId}/receipt

URI Parameters

Body

HTTP status code 201

Body