IMS One Roster Ref Impl.

OneRoster® API version 1.1 spec is availble here: https://www.imsglobal.org/oneroster-v11-final-specification

OR REST APIs 1.1

AUTHORIZATIONOAuth 1.0

Consumer Key

12345

Consumer Secret

secret

Academic Sessions

AUTHORIZATIONOAuth 1.0

This folder is using OAuth 1.0 from folderOR REST APIs 1.1

Grading Periods

AUTHORIZATIONOAuth 1.0

This folder is using OAuth 1.0 from folderOR REST APIs 1.1

GETGet All Grading Periods

https://or-ri.imsglobal.org/ims/oneroster/v1p1/gradingPeriods?offset=0&limit=100

Gets a page of grading periods.

AUTHORIZATIONOAuth 1.0

This request is using OAuth 1.0 from folderOR REST APIs 1.1

PARAMS

offset

limit

100

filter

status='active'

Filters for active records

Example Request

curl

curl --location 'https://or-ri.imsglobal.org/ims/oneroster/v1p1/gradingPeriods?offset=0&limit=100' \
--header 'Accept: application/json'

200 OK

Example Response

json

{
  "academicSessions": [
    {
      "children": [],
      "dateLastModified": "2020-02-25T13:50:57Z",
      "endDate": "2020-02-25",
      "metadata": {
        "number_of_counselors": 4
      },
      "parent": {
        "href": "https://or-ri.imsglobal.org/ims/oneroster/v1p1/academicSessions/d99c61e6-57d5-11ea-a767-3a6d5a0778e8",
        "sourcedId": "d99c61e6-57d5-11ea-a767-3a6d5a0778e8",
        "type": "term"
      },
      "schoolYear": 2019,
      "sourcedId": "d99cb9a2-57d5-11ea-85b8-3a6d5a0778e8",
      "startDate": "2020-02-25",
      "status": "active",
      "title": "Spring grading period",
      "type": "gradingPeriod"
    }
  ]
}

Server

openresty/1.15.8.1

Date

Tue, 21 Apr 2020 15:10:13 GMT

Content-Type

application/json; charset=utf-8

Transfer-Encoding

chunked

Connection

keep-alive

Vary

Accept-Encoding

cache-control

max-age=0, private, must-revalidate

x-request-id

c09a3f2d96c9b9b252fadec93224b5cc

Strict-Transport-Security

max-age=15724800; includeSubDomains

Content-Encoding

gzip

GETGet Grading Period

https://or-ri.imsglobal.org/ims/oneroster/v1p1/gradingPeriods/d99cb9a2-57d5-11ea-85b8-3a6d5a0778e8

Gets a single grading period.

AUTHORIZATIONOAuth 1.0

This request is using OAuth 1.0 from folderOR REST APIs 1.1

HEADERS

application/json

PARAMS

filter

status='active'

Filters for active records

Example Request

curl

curl --location 'https://or-ri.imsglobal.org/ims/oneroster/v1p1/gradingPeriods/d99cb9a2-57d5-11ea-85b8-3a6d5a0778e8' \
--header 'Accept: application/json'

200 OK

Example Response

json

{
  "academicSession": {
    "children": [],
    "dateLastModified": "2020-02-25T13:50:57Z",
    "endDate": "2020-02-25",
    "metadata": {
      "number_of_counselors": 4
    },
    "parent": {
      "href": "https://or-ri.imsglobal.org/ims/oneroster/v1p1/academicSessions/d99c61e6-57d5-11ea-a767-3a6d5a0778e8",
      "sourcedId": "d99c61e6-57d5-11ea-a767-3a6d5a0778e8",
      "type": "term"
    },
    "schoolYear": 2019,
    "sourcedId": "d99cb9a2-57d5-11ea-85b8-3a6d5a0778e8",
    "startDate": "2020-02-25",
    "status": "active",
    "title": "Spring grading period",
    "type": "gradingPeriod"
  }
}

Server

openresty/1.15.8.1

Date

Tue, 21 Apr 2020 15:12:50 GMT

Content-Type

application/json; charset=utf-8

Transfer-Encoding

chunked

Connection

keep-alive

Vary

Accept-Encoding

cache-control

max-age=0, private, must-revalidate

x-request-id

b40c70852ffaa28f71c66954929a77ad

Strict-Transport-Security

max-age=15724800; includeSubDomains

Content-Encoding

gzip