OneRoster API

Return collection of orgs.

GEThttps://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/orgs

Response

Orgs response

Body

orgsarray of Org (all of)

Request

const response = await fetch('https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/orgs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "orgs": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2024-09-19T06:52:42.351Z",
      "name": "text",
      "type": "text",
      "identifier": "text",
      "parent": {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      },
      "children": [
        {
          "href": "text",
          "sourcedId": "text",
          "type": "text"
        }
      ]
    }
  ]
}

Return specific org.

GEThttps://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/orgs/{id}

Path parameters

id*string

sourcedId of the org to get

Response

Org response

Body

orgOrg (all of)

Request

const response = await fetch('https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/orgs/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "org": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2024-09-19T06:52:42.351Z",
    "name": "text",
    "type": "text",
    "identifier": "text",
    "parent": {
      "href": "text",
      "sourcedId": "text",
      "type": "text"
    },
    "children": [
      {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      }
    ]
  }
}

Return collection of Schools. A School is an instance of an Org.

GEThttps://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/schools

Response

Schools response

Body

orgsarray of Org (all of)

Request

const response = await fetch('https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/schools', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "orgs": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2024-09-19T06:52:42.351Z",
      "name": "text",
      "type": "text",
      "identifier": "text",
      "parent": {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      },
      "children": [
        {
          "href": "text",
          "sourcedId": "text",
          "type": "text"
        }
      ]
    }
  ]
}

Return specific School. A School is an instance of an Org.

GEThttps://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/schools/{id}

Path parameters

id*string

sourcedId of the School to get

Response

School response

Body

orgOrg (all of)

Request

const response = await fetch('https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/schools/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "org": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2024-09-19T06:52:42.351Z",
    "name": "text",
    "type": "text",
    "identifier": "text",
    "parent": {
      "href": "text",
      "sourcedId": "text",
      "type": "text"
    },
    "children": [
      {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      }
    ]
  }
}

Return collection of enrollments.

GEThttps://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/enrollments

Response

Enrollments response

Body

enrollmentsarray of Enrollment (all of)

Request

const response = await fetch('https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/enrollments', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "enrollments": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2024-09-19T06:52:42.351Z",
      "user": {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      },
      "class": {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      },
      "school": {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      },
      "role": "text",
      "primary": false,
      "beginDate": "2024-09-19",
      "endDate": "2024-09-19"
    }
  ]
}

Return specific enrollment.

GEThttps://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/enrollments/{id}

Path parameters

id*string

sourcedId of the enrollment to get

Response

Enrollment response

Body

enrollmentEnrollment (all of)

Request

const response = await fetch('https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/enrollments/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "enrollment": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2024-09-19T06:52:42.351Z",
    "user": {
      "href": "text",
      "sourcedId": "text",
      "type": "text"
    },
    "class": {
      "href": "text",
      "sourcedId": "text",
      "type": "text"
    },
    "school": {
      "href": "text",
      "sourcedId": "text",
      "type": "text"
    },
    "role": "text",
    "primary": false,
    "beginDate": "2024-09-19",
    "endDate": "2024-09-19"
  }
}

Return collection of terms. A Term is an instance of an AcademicSession.

GEThttps://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/terms

Response

Terms response

Body

academicSessionsarray of AcademicSession (all of)

Request

const response = await fetch('https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/terms', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "academicSessions": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2024-09-19T06:52:42.351Z",
      "title": "text",
      "startDate": "2024-09-19",
      "endDate": "2024-09-19",
      "type": "text",
      "parent": {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      },
      "children": [
        {
          "href": "text",
          "sourcedId": "text",
          "type": "text"
        }
      ],
      "schoolYear": "text"
    }
  ]
}

Return specific term. A Term is an instance of an AcademicSession.

GEThttps://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/terms/{id}

Path parameters

id*string

sourcedId of the term to get

Response

Term response

Body

academicSessionAcademicSession (all of)

Request

const response = await fetch('https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/terms/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "academicSession": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2024-09-19T06:52:42.351Z",
    "title": "text",
    "startDate": "2024-09-19",
    "endDate": "2024-09-19",
    "type": "text",
    "parent": {
      "href": "text",
      "sourcedId": "text",
      "type": "text"
    },
    "children": [
      {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      }
    ],
    "schoolYear": "text"
  }
}

Return collection of all academic sessions.

GEThttps://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/academicSession

Response

Academic session response

Body

academicSessionsarray of AcademicSession (all of)

Request

const response = await fetch('https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/academicSession', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "academicSessions": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2024-09-19T06:52:42.351Z",
      "title": "text",
      "startDate": "2024-09-19",
      "endDate": "2024-09-19",
      "type": "text",
      "parent": {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      },
      "children": [
        {
          "href": "text",
          "sourcedId": "text",
          "type": "text"
        }
      ],
      "schoolYear": "text"
    }
  ]
}

Return specific academic session.

GEThttps://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/academicSession/{id}

Path parameters

id*string

sourcedId of the academic session to get

Response

Academic session response

Body

academicSessionAcademicSession (all of)

Request

const response = await fetch('https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/academicSession/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "academicSession": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2024-09-19T06:52:42.351Z",
    "title": "text",
    "startDate": "2024-09-19",
    "endDate": "2024-09-19",
    "type": "text",
    "parent": {
      "href": "text",
      "sourcedId": "text",
      "type": "text"
    },
    "children": [
      {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      }
    ],
    "schoolYear": "text"
  }
}

Return collection of grading periods. A grading period is an instance of an AcademicSession.

GEThttps://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/gradingPeriods

Response

Grading periods response

Body

academicSessionsarray of AcademicSession (all of)

Request

const response = await fetch('https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/gradingPeriods', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "academicSessions": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2024-09-19T06:52:42.351Z",
      "title": "text",
      "startDate": "2024-09-19",
      "endDate": "2024-09-19",
      "type": "text",
      "parent": {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      },
      "children": [
        {
          "href": "text",
          "sourcedId": "text",
          "type": "text"
        }
      ],
      "schoolYear": "text"
    }
  ]
}

Return specific grading period. A grading period is an instance of an academic session.

GEThttps://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/gradingPeriods/{id}

Path parameters

id*string

sourcedId of the grading period to get

Response

Grading period response

Body

academicSessionAcademicSession (all of)

Request

const response = await fetch('https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/gradingPeriods/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "academicSession": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2024-09-19T06:52:42.351Z",
    "title": "text",
    "startDate": "2024-09-19",
    "endDate": "2024-09-19",
    "type": "text",
    "parent": {
      "href": "text",
      "sourcedId": "text",
      "type": "text"
    },
    "children": [
      {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      }
    ],
    "schoolYear": "text"
  }
}

Return collection of courses.

GEThttps://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/courses

Response

Courses response

Body

coursesarray of Course (all of)

Request

const response = await fetch('https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/courses', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "courses": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2024-09-19T06:52:42.351Z",
      "title": "text",
      "schoolYear": {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      },
      "courseCode": "text",
      "grades": [
        "text"
      ],
      "subjects": [
        "text"
      ],
      "subjectCodes": [
        "text"
      ],
      "resources": [
        {
          "href": "text",
          "sourcedId": "text",
          "type": "text"
        }
      ]
    }
  ]
}

Return specific course.

GEThttps://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/courses/{id}

Path parameters

id*string

sourcedId of the course to get

Response

Courses response

Body

courseCourse (all of)

Request

const response = await fetch('https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/courses/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "course": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2024-09-19T06:52:42.351Z",
    "title": "text",
    "schoolYear": {
      "href": "text",
      "sourcedId": "text",
      "type": "text"
    },
    "courseCode": "text",
    "grades": [
      "text"
    ],
    "subjects": [
      "text"
    ],
    "subjectCodes": [
      "text"
    ],
    "resources": [
      {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      }
    ]
  }
}

Return collection of classes.

GEThttps://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/classes

Response

Classes response

Body

classesarray of Class (all of)

Request

const response = await fetch('https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/classes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "classes": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2024-09-19T06:52:42.351Z",
      "title": "text",
      "classCode": "text",
      "classType": "text",
      "location": "text",
      "grades": [
        "text"
      ],
      "subjects": [
        "text"
      ],
      "course": {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      },
      "school": {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      },
      "terms": [
        {
          "href": "text",
          "sourcedId": "text",
          "type": "text"
        }
      ],
      "subjectCodes": [
        "text"
      ],
      "periods": [
        "text"
      ],
      "resources": [
        {
          "href": "text",
          "sourcedId": "text",
          "type": "text"
        }
      ]
    }
  ]
}

Return specific class.

GEThttps://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/classes/{id}

Path parameters

id*string

sourcedId of the class to get

Response

Class response

Body

classClass (all of)

Request

const response = await fetch('https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/classes/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "class": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2024-09-19T06:52:42.351Z",
    "title": "text",
    "classCode": "text",
    "classType": "text",
    "location": "text",
    "grades": [
      "text"
    ],
    "subjects": [
      "text"
    ],
    "course": {
      "href": "text",
      "sourcedId": "text",
      "type": "text"
    },
    "school": {
      "href": "text",
      "sourcedId": "text",
      "type": "text"
    },
    "terms": [
      {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      }
    ],
    "subjectCodes": [
      "text"
    ],
    "periods": [
      "text"
    ],
    "resources": [
      {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      }
    ]
  }
}

Return collection of users.

GEThttps://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/users

Response

Users response

Body

usersarray of User (all of)

Request

const response = await fetch('https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/users', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "users": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2024-09-19T06:52:42.351Z",
      "username": "text",
      "userIds": [
        {
          "type": "text",
          "identifier": "text"
        }
      ],
      "enabledUser": false,
      "givenName": "text",
      "familyName": "text",
      "middleName": "text",
      "role": "text",
      "identifier": "text",
      "email": "text",
      "sms": "text",
      "phone": "text",
      "agents": [
        {
          "href": "text",
          "sourcedId": "text",
          "type": "text"
        }
      ],
      "orgs": [
        {
          "href": "text",
          "sourcedId": "text",
          "type": "text"
        }
      ],
      "grades": [
        "text"
      ],
      "password": "text"
    }
  ]
}

Return specific user.

GEThttps://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/users/{id}

Path parameters

id*string

sourcedId of the user to get

Response

User response

Body

userUser (all of)

Request

const response = await fetch('https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/users/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "user": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2024-09-19T06:52:42.351Z",
    "username": "text",
    "userIds": [
      {
        "type": "text",
        "identifier": "text"
      }
    ],
    "enabledUser": false,
    "givenName": "text",
    "familyName": "text",
    "middleName": "text",
    "role": "text",
    "identifier": "text",
    "email": "text",
    "sms": "text",
    "phone": "text",
    "agents": [
      {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      }
    ],
    "orgs": [
      {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      }
    ],
    "grades": [
      "text"
    ],
    "password": "text"
  }
}

Return collection of teachers. A teacher is an instance of a user.

GEThttps://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/teachers

Response

Teachers response

Body

usersarray of User (all of)

Request

const response = await fetch('https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/teachers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "users": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2024-09-19T06:52:42.351Z",
      "username": "text",
      "userIds": [
        {
          "type": "text",
          "identifier": "text"
        }
      ],
      "enabledUser": false,
      "givenName": "text",
      "familyName": "text",
      "middleName": "text",
      "role": "text",
      "identifier": "text",
      "email": "text",
      "sms": "text",
      "phone": "text",
      "agents": [
        {
          "href": "text",
          "sourcedId": "text",
          "type": "text"
        }
      ],
      "orgs": [
        {
          "href": "text",
          "sourcedId": "text",
          "type": "text"
        }
      ],
      "grades": [
        "text"
      ],
      "password": "text"
    }
  ]
}

Return specific teacher. A teacher is an instance of a user.

GEThttps://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/teachers/{id}

Path parameters

id*string

sourcedId of the teacher to get

Response

Teacher response

Body

userUser (all of)

Request

const response = await fetch('https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/teachers/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "user": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2024-09-19T06:52:42.351Z",
    "username": "text",
    "userIds": [
      {
        "type": "text",
        "identifier": "text"
      }
    ],
    "enabledUser": false,
    "givenName": "text",
    "familyName": "text",
    "middleName": "text",
    "role": "text",
    "identifier": "text",
    "email": "text",
    "sms": "text",
    "phone": "text",
    "agents": [
      {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      }
    ],
    "orgs": [
      {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      }
    ],
    "grades": [
      "text"
    ],
    "password": "text"
  }
}

Return the collection of teachers teaching at this school.

GEThttps://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/schools/{schoolId}/teachers

Path parameters

schoolId*string

sourcedId of the school to get teachers

Response

Teachers response

Body

usersarray of User (all of)

Request

const response = await fetch('https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/schools/{schoolId}/teachers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "users": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2024-09-19T06:52:42.351Z",
      "username": "text",
      "userIds": [
        {
          "type": "text",
          "identifier": "text"
        }
      ],
      "enabledUser": false,
      "givenName": "text",
      "familyName": "text",
      "middleName": "text",
      "role": "text",
      "identifier": "text",
      "email": "text",
      "sms": "text",
      "phone": "text",
      "agents": [
        {
          "href": "text",
          "sourcedId": "text",
          "type": "text"
        }
      ],
      "orgs": [
        {
          "href": "text",
          "sourcedId": "text",
          "type": "text"
        }
      ],
      "grades": [
        "text"
      ],
      "password": "text"
    }
  ]
}

Return collection of students. A student is an instance of a user.

GEThttps://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/students

Response

Students response

Body

usersarray of User (all of)

Request

const response = await fetch('https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/students', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "users": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2024-09-19T06:52:42.351Z",
      "username": "text",
      "userIds": [
        {
          "type": "text",
          "identifier": "text"
        }
      ],
      "enabledUser": false,
      "givenName": "text",
      "familyName": "text",
      "middleName": "text",
      "role": "text",
      "identifier": "text",
      "email": "text",
      "sms": "text",
      "phone": "text",
      "agents": [
        {
          "href": "text",
          "sourcedId": "text",
          "type": "text"
        }
      ],
      "orgs": [
        {
          "href": "text",
          "sourcedId": "text",
          "type": "text"
        }
      ],
      "grades": [
        "text"
      ],
      "password": "text"
    }
  ]
}

Return specific student. A student is an instance of a user.

GEThttps://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/students/{id}

Path parameters

id*string

sourcedId of the student to get

Response

Student response

Body

userUser (all of)

Request

const response = await fetch('https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/students/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "user": {
    "sourcedId": "text",
    "status": "text",
    "dateLastModified": "2024-09-19T06:52:42.351Z",
    "username": "text",
    "userIds": [
      {
        "type": "text",
        "identifier": "text"
      }
    ],
    "enabledUser": false,
    "givenName": "text",
    "familyName": "text",
    "middleName": "text",
    "role": "text",
    "identifier": "text",
    "email": "text",
    "sms": "text",
    "phone": "text",
    "agents": [
      {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      }
    ],
    "orgs": [
      {
        "href": "text",
        "sourcedId": "text",
        "type": "text"
      }
    ],
    "grades": [
      "text"
    ],
    "password": "text"
  }
}

Return the collection of students attending this school.

GEThttps://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/schools/{schoolId}/students

Path parameters

schoolId*string

sourcedId of the school to get students

Response

Students response

Body

usersarray of User (all of)

Request

const response = await fetch('https://oneroster.us2.kimonocloud.com/ims/oneroster/v1p1/schools/{schoolId}/students', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "users": [
    {
      "sourcedId": "text",
      "status": "text",
      "dateLastModified": "2024-09-19T06:52:42.351Z",
      "username": "text",
      "userIds": [
        {
          "type": "text",
          "identifier": "text"
        }
      ],
      "enabledUser": false,
      "givenName": "text",
      "familyName": "text",
      "middleName": "text",
      "role": "text",
      "identifier": "text",
      "email": "text",
      "sms": "text",
      "phone": "text",
      "agents": [
        {
          "href": "text",
          "sourcedId": "text",
          "type": "text"
        }
      ],
      "orgs": [
        {
          "href": "text",
          "sourcedId": "text",
          "type": "text"
        }
      ],
      "grades": [
        "text"
      ],
      "password": "text"
    }
  ]
}

Last updated 6 months ago