Developer s Guide
RIC One API provides education application developers with an easy and consistent way to access class roster data, while enabling districts to retain complete control of privacy and security for their students and staff. RIC One is available to all RIC member district in the state of New York. Data is partitioned into 12 regional data providers hosted within the private cloud of the Regional Information Centers.
RIC One API supports authenticating using the following methods:
- OAuth 2.0
RIC One API separates authentication and data access. There is a single authentication endpoint that all apps initially connect to using credentials provided during the onboarding process. Applications login using the username and password provided during the onboarding process to obtain a token and list of regional data providers (endpoints) to which they have been granted access. If your app is used in multiple RICs, you will receive a list containing multiple endpoints. If your app is used only within a single RIC, you will only see a single endpoint in the results of the call to the login service.
Acquire a token
You can retrieve your access token by logging in to https://auth.ricone.org/login. There is a set of test and demo logins available to use for self-testing. By default, tokens expire after 60 minutes and must be refreshed.
Example OAuth Response
In the example below an account with the username of DemoApp has logged in and received a JSON payload. This response contains both a token and an array of endpoints. The token received will be used to authenticate at the specified regional provider endpoint. Each endpoint contains information about the provider where the data is located for each of the districts associated to the authenticated application.
All names, values and tokens are for examples purposes only.
Authenticating with your token
Making authenticated calls to the API can be achieved by adding the bearer token to the "Authorization" header. Example:
GET /xStudents HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
RIC One API offers a variety of responses. You can use Response Headers to gain additional insight into your request as well as HTTP status codes to further explain what state your request was when completed. Content-Type fully supports JSON and XML responses, though the default type is XML.
The number of records being requested.
The current page being requested. Starts at position 1.
Total number of records found.
The last page data will be found.
Thu, 14 May 2015 14:54:04 GMT
The date the request started.
The time the request started.
The Id of the Provider where the request was placed.
The service path being accessed.
The current school year of the response data.
The type of request being made.
The type of data being requested.
HTTP GET Status Response
HTTP Status Code
Ok The request completed successfully and returned data.
Created Your submission of data has successfully be sent to the server.
No Content The request completed successfully, but no data was found.
Forbidden The request has failed to authenticate, or the service path is invalid.
If you know you are accessing a valid service path then It is possible that your access token has expired and that you may need to generate a new one. Otherwise, check that the service path is valid.
Not Found The page you are requesting does not exist.
Check that the service path you are questing is valid. This error may occur when searching by a reference identifier.
Internal Server Error The API has encountered an unexpected condition.
Wait and try again. If the problem persists please contact your local RIC One API support team.
The Developer Sandbox is an area that allows application developers a place to familiarize themselves with the data accessible through RIC One API. The sandbox includes an API Explorer https://sandbox.ricone.org and access to a complete sample dataset represented in the SIF xPress data model. This will allow developers to perform GET operations and learn the layout of the RIC One API data models.
We provide client libraries for .NET and Java that you may use as a reference implementation or incorporate directly into your product code.
RIC One API is implemented on a feature rich, open source toolset called the Common Framework. This technology is used widely in Australia and has excellent scaling characteristics. It can easily support multiple API output models. Our featured API is known as xPress Roster. In the future we may support additional standards based on market demand.
xPress Roster API
The RIC One project team developed a standards-based API that has been adopted by the Access For Learning community (A4L, formerly known as the SIF Association) as a part of its North American national standard. You can view the API explorer here: (https://sandbox.ricone.org/xPress/)
The main design goal for the xPress Roster API was to provide an easy to use on-the-wire representation of rosters and necessary related resources. Following is a high level Entity Relationship Diagram that depicts the relationship among the resources.
Since this model is normalized for interoperability and, for the sake of convenience, most commonly used elements are represented in multiple resources. The underlying physical model within the API provider data store is responsible for maintaining integrity.
In order maintain anonymity and uniqueness, RIC One API assigns each record with a unique reference identifier (refId) or GUID. This is based on Version 4 of the Universally Unique Identifier.
What does a refId look like?
Use of RefIds
Within RIC One API refIds are used for consistency within the system. The refIds are used as a standardized way of filtering data objects to the individual record. For example, if you want to see the full record for an individual student you would request
Or the school enrollment of a particular student:
It is recommended that when developing against the Data API, refIds are used as primary key. However natural (SIS) keys are supported for certain resources and service paths.
Student Identifiers (Local)
In addition to refIds, student resources within RIC One API also generally contain the SIS provided primary key, also known as localId. This identifier can be referenced via
These natural SIS identifiers may be used in place of the refId to query a specific resource. It is generally recommended that refId is used since it is more durable (SIS identifiers can and do change on occasion).
Staff Identifiers (Local)
As with Student Identifiers, staff within RIC One API have additional identifiers associated to their record. These include:
Scoping Requests for Data
There are multiple strategies you may take to scope requests for data depending on your application's tenancy implementation and data model. Two of the main approaches are to scope by Provider or by District. If you look at the service paths in the table below you can see how you might do this. If you wanted to retrieve all Schools regardless of which district they were a part of you could simply call:
If you wanted to retrieve a set of Schools based on a district you might do:
When taking the By District approach you will first have to retrieve a list of xLeas and then iterate over them. This approach will require an additional call to the API, but it will increase the overall performance when returning data about any particular object.
See API Library for documentation on how to implement this.
for(xLea lea : api.request.getXLeas())
RIC One API offers many ways in which you can retrieve your data. Whether it be through returning all records for a particular object, a single record, or all records by association.
Service Paths by Data Model
Objects on the right are returned using the object on the left and it s Reference Identifier.
xPress Service Path
LEAs (i.e. districts or divisions)
Returns all Leas.
Returns a single Lea by refId.
Returns a single Lea by BEDS code or Local Id.
Returns Leas associated to a specific School by refId.
Returns Leas associated to a specific Roster by refId.
Returns Leas associated to a specific Staff by refId.
Returns Leas associated to a specific Student by refId.
Returns Leas associated to a specific Contact by refId.
Returns all Schools.
Returns a single School by refId.
Returns a single School by BEDS code or Local Id.
Returns Schools associated to a specific Lea by refId.
Returns Schools associated to a specific Calendar by refId.
Returns Schools associated to a specific Course by refId.
Returns Schools associated to a specific Roster by refId.
Returns Schools associated to a specific Staff by refId.
Returns Schools associated to a specific Student by refId.
Returns Schools associated to a specific Contact by refId.
Returns all Calendars.
Returns a single Calendar by refId.
Returns Calendars associated to a specific Lea by refId.
Returns Calendars associated to a specific School by refId.
Returns all Courses.
Returns a single Course by refId.
Returns Courses associated to a specific Lea by refId.
Returns Courses associated to a specific School by refId.
Returns Courses associated to a specific Roster by refId.
Returns all Rosters.
Returns a single Roster by refId.
Returns Rosters associated to a specific Lea by refId.
Returns Rosters associated to a specific School by refId.
Returns Rosters associated to a specific Course by refId.
Returns Sections associated to a specific Staff by refId.
Returns Rosters associated to a specific Student by refId.
Returns all Staff.
Returns a single Staff by refId.
Returns a single Staff by state or local id.
Returns Staff associated to a specific Lea by refId.
Returns Staff associated to a specific School by refId.
Returns Staff associated to a specific Course by refId.
Returns Staff associated to a specific Roster by refId.
Returns Staff associated to a specific Student by refId.
Returns all Students.
Returns a single Student by refId.
Returns a single Student by state or local id.
Returns Students associated to a specific Lea by refId.
Returns Students associated to a specific School by refId.
Returns Students associated to a specific Roster by refId.
Returns Students associated to a specific Staff by refId.
Returns Students associated to a specific Contact by refId.
Returns all Contacts.
Returns a single Contact by refId.
Returns Contacts associated to a specific Lea by refId.
Returns Contacts associated to a specific School by refId.
Returns Contacts associated to a specific Student by refId.
To make the model self documenting multi-valued items are split into two parts: a primary and other structure. The primary structure can be depended on to provide the main value of interest to most clients. For example, when you see name and otherNames you would use the name field as the primary name for the particular object and, unless your application needs the other names, would ignore those fields. This pattern applies to all items that are potentially multi-valued. This allows us to provide you the best of both worlds: if you only need the primary item from the list just code to look for that primary item; if your application needs additional details, the other structure can provide them.
For xStudents the lists include
- name and otherNames
- LocalID and otherId s
- phoneNumber and otherPhoneNumbers
- email and otherEmail
- enrollment.lea or otherEnrollments.lea
Example of ids / otherIds and phoneNumber / otherPhoneNumbers construct in xSchool:
"schoolName": "Arbor Grove Elementary",
"line1": "102 West Main",
Field Level Access Controls
When using the API your application will only see the subset of the fields your applications is approved for. This is decided during the onboarding process between the district, vendor, and a RIC One Onboarding Technician.
Requests to the Data API can return large amounts of data. To increase performance, the use of the API's paging features is recommended.
The navigationPage attribute describes your current location in paging. Starts at position 0.
The navigationPageSize attribute allows you determine the number of results requested per page.
Example Paging Request
The example below shows how you would append these attributes to a service path.
Content Types/Serialization Format
By default, the Data API returns results in XML format but supports returning data in JSON. For compatibility with your application, the return type can be specified.
Example XML Call
Example JSON Call
By default, the Data API will return the latest school year currently available. If previous years data is needed, a request header or query parameter MUST be added to your REST request.
The Changes Since mechanism allows an application to request data that has changed since a given point . The RIC One opaque marker uses an ISO8601 timestamp that indicates a point since the last changes have been requested.
Step 1. Application Requests Changes Since
Step 2: Provider Response
Step 3: Client Interprets Changes
Note: Applications which choose to use the natural ids as keys in their applications for primary key will not be able to support "Changes Since" fully. Delete events contain only the refId of the object and applications will need to maintain the linking of refIds to natural identifiers (e.g. student.localId, staff.localId)
RIC One Developer s Guide, 9/14/2018