Sample Transactions - State Reporting-VDG

Example: Creating a Student

Putting the pieces in the above sections together, we can look at the contents of a sample transaction:

POST "https://ed-fi.grandbend.edu:443/v5.1.0/api/data/v3/ed-fi/students" 
accept: application/json 
Content-Type: application/json
authorization: Bearer 20ea10c525354cdaa32aacfb71bc2ff8
{
    "studentUniqueId": "6048999",
    "birthDate": "2009-07-22",
    "firstName": "Julie",
    "lastSurname": "Martinez",
    "middleName": "Macon"
}

In this example, you can see that this is a POST operation, so is creating a new Student API resource.  There is an authorization token in the HTTP header ("Bearer 20ea10c525354cdaa32aacfb71bc2ff8"), and then the actual contents of the new Student record, in JSON format.

A response from your system would look like is as follows:

201
access-control-allow-origin: * 
access-control-expose-headers: * 
connection: keep-alive 
content-length: 0 
date: Wed07 Apr 2021 17:21:27 GMT 
etag: "5249220147305124204" 
location: https://api.ed-fi.org:443/data/v3/ed-fi/students/918bb778138b4ab2a44e599fbcbf7f66  

This is an empty response with only HTTP headers (a few headers have been removed to allow us to focus on the ones most important to our discussion).

• The 201 code indicates that the request was successful and the API resource was created.
• The location field returns the resource ID for the new entity – in this case: 918bb778138b4ab2a44e599fbcbf7f66. A GET request to /ed-fi/students/918bb778138b4ab2a44e599fbcbf7f66 would return the entity that was just created.
• Other elements –  such as an ETag and timestamp – are also provided. Generally these are not needed by most applications.

Example: Creating a Student Attendance Record

A second example that represents a more complex example would look like this:

POST "https://ed-fi.grandbend.edu:443/v5.1.0/api/data/v3/ed-fi/studentSchoolAttendanceEvents" 
accept: application/json 
Content-Type: application/json
authorization: Bearer 20ea10c525354cdaa32aacfb71bc2ff8
{
    "schoolReference": {
        "schoolId": 255901107
    },
    "sessionReference": {
        "schoolId": 255901107,
        "schoolYear": 2011,
        "sessionName": "2010-2011 Fall Semester"
    },
    "studentReference": {
        "studentUniqueId": "604877"
    },
    "attendanceEventCategoryDescriptor": 
         "uri://ed-fi.org/AttendanceEventCategoryDescriptor#Unexcused Absence",
    "eventDate": "2010-08-25",
    "attendanceEventReason": "Absent unexcused",
    "eventDuration": 1
}

This example of a POST showcases a few more advanced elements of a Ed-Fi transaction. 

• In this example, you can see references to other API resources: schoolReference, sessionReference, and studentAttendance. These resources must exist in the API or the transaction will be rejected by the API. You will also note that the reference is made via the natural key to the resource and not the REST id — you can read about this in the upcoming section API Resource Keys.
• Also, in this example, you can see an example of how Ed-Fi handles controlled vocabularies via the string "uri://ed-fi.org/AttendanceEventCategoryDescriptor#Unexcused Absence". These are called "descriptors" in Ed-Fi, and you can read more about them in the upcoming section Descriptors.
• Also present here is an example of date formatting - read more on that in the section Date and DateTime Formats.