This is an extract of the information from the official source.

OAuth 2 Authorization

API Overview

Local Education Agency (LEA)

Schools

Staffs

Students

Contacts

Calendars

Courses

Rosters

Common Request Parameters


OAuth 2 Authorization

Request:

The request for client credentials must contain WWW BASIC authorization with both the client_id and client secret key in the request header, such as: ‘Authorization’: ‘Basic {data}’, where data = Base64.encode(‘{client_id}:{client secret}’).


   

POST

datahub/oauth/token

Endpoint for authenticating a client.

 

     

PARAMETER

MODE

TYPE

DESCRIPTION

grant_type

required

String

The type of the response (should be: ‘client_credentials’)

Example:

 

METHOD

POST

URL

https://{hostname}/datahub/oauth/auth

BODY

grant_type=client_credentials

HEADERS

Authorization: Basic Y2xpZW50aWQ6Y2xpZW50c2VjcmV0


Response:

The API returns the following response on successful authentication:

{

 "access_token": "zyx",

 "token_type": "bearer",

 "expires_in": 7199

}

   

FIELD

TYPE

DESCRIPTION

access_token

String

OAuth 2.0 Access Token

token_type

String

Token type, which is always 'bearer.’

expires_in

Integer

Expiration time in seconds

scope

String

List of scopes that define the data access level.



 

API Overview


   

Base URL

datahub/services/v1/xpress/api

The prefix for all requests in following API EndPoints


Local Education Agency (LEA)

   

GET

/requests/xLeas

Retrieves a list of Local Education Agencies (LEA) you have access to.

GET

/requests/xLeas/{refId}

Retrieves information of a specific LEA.

GET

/requests/xSchools/{refId}/xLeas

Retrieve Lea of a specific School

GET

/requests/xRosters/{refId}/xLeas

Retrieve Lea of a specific Roster

GET

/requests/xStaffs/{refId}/xLeas

Retrieve Lea of a specific Staff

GET

/requests/xStudents/{refId}/xLeas

Retrieve Lea of a specific Student

GET

/requests/xContacts/{refId}/xLeas

Retrieve Lea of a specific Contact


Schools

   

GET

/requests/xSchools

Retrieves a list of Schools you have access to.

GET

/requests/xSchools/{refId}

Retrieves information of a specific School.

GET

/requests/xLeas/{refId}/xSchools

Retrieves a list of schools you have access to for a specific LEA.

GET

/requests/xCalendars/{refId}/xSchools

Retrieves a list of schools you have access to for a specific Calendar.

GET

/requests/xCourses/{refId}/xSchools

Retrieves a list of schools you have access to for a specific Course.

GET

/requests/xRosters/{refId}/xSchools

Retrieves a list of schools you have access to for a specific Roster.

GET

/requests/xStaffs/{refId}/xSchools

Retrieves a list of schools you have access to for a specific Staff.

GET

/requests/xStudents/{refId}/xSchools

Retrieves a list of schools you have access to for a specific Student.

GET

/requests/xContacts/{refId}/xSchools

Retrieves a list of schools you have access to for a specific Contact.


Staffs

   

GET

/requests/xStaffs

Retrieves a list of Staffs you have access to.

GET

/requests/xStaffs/{refId}

Retrieves information of a specific Staff.

GET

/requests/xLeas/{refId}/xStaffs

Retrieves a list of Staffs you have access to for a specific LEA.

GET

/requests/xSchools/{refId}/xStaffs

Retrieves a list of Staffs you have access to for a specific School.

GET

/requests/xCourses/{refId}/xStaffs

Retrieves a list of Staffs you have access to for a specific Course.

GET

/requests/xRosters/{refId}/xStaffs

Retrieves a list of Staffs you have access to for a specific Roster.

GET

/requests/xStudents/{refId}/xStaffs

Retrieves a list of Staffs you have access to for a specific Student.


Students

   

GET

/requests/xStudents

Retrieves a list of Students you have access to.

GET

/requests/xStudents/{refId}

Retrieves information of a specific Student.

GET

/requests/xLeas/{refId}/xStudents

Retrieves a list of Students you have access to for a specific LEA.

GET

/requests/xSchools/{refId}/xStudents

Retrieves a list of Students you have access to for a specific School.

GET

/requests/xRosters/{refId}/xStudents

Retrieves a list of Students you have access to for a specific Roster.

GET

/requests/xStaffs/{refId}/xStudents

Retrieves a list of Students you have access to for a specific Staff.

GET

/requests/xContacts/{refId}/xStudents

Retrieves a list of Students you have access to for a specific Contact.


Contacts

   

GET

/requests/xContacts

Retrieves a list of Contacts you have access to.

GET

/requests/xContacts/{refId}

Retrieves information of a specific Contact.

GET

/requests/xLeas/{refId}/xContacts

Retrieves a list of Contacts you have access to for a specific LEA.

GET

/requests/xSchools/{refId}/xContacts

Retrieves a list of Contacts you have access to for a specific School.

GET

/requests/xStudents/{refId}/xContacts

Retrieves a list of Contacts you have access to for a specific Student.


Calendars

   

GET

/requests/xCalendars

Retrieves a list of Calendars you have access to.

GET

/requests/xCalendars/{refId}

Retrieves information of a specific Calendar.

GET

/requests/xLeas/{refId}/xCalendars

Retrieves a list of Calendars you have access to for a specific LEA.

GET

/requests/xSchools/{refId}/xCalendars

Retrieves a list of Calendars you have access to for a specific School.


Courses

   

GET

/requests/xCourses

Retrieves a list of Courses you have access to.

GET

/requests/xCourses/{refId}

Retrieves information of a specific Course.

GET

/requests/xLeas/{refId}/xCourses

Retrieves a list of Courses you have access to for a specific LEA.

GET

/requests/xSchools/{refId}/xCourses

Retrieves a list of Courses you have access to for a specific School.

GET

/requests/xRosters/{refId}/xCourses

Retrieves a list of Courses you have access to for a specific Roster.


Rosters

   

GET

/requests/xRosters

Retrieves a list of Rosters you have access to.

GET

/requests/xRosters/{refId}

Retrieves information of a specific Roster.

GET

/requests/xLeas/{refId}/xRosters

Retrieves a list of Roster you have access to for a specific LEA.

GET

/requests/xSchools/{refId}/xRosters

Retrieves a list of Roster you have access to for a specific LEA.

GET

/requests/xCourses/{refId}/xRosters

Retrieves a list of Roster you have access to for a specific LEA.

GET

/requests/xStaffs/{refId}/xRosters

Retrieves a list of Roster you have access to for a specific LEA.

GET

/requests/xStudents/{refId}/xRosters

Retrieves a list of Roster you have access to for a specific LEA.

Common Request Parameters

     

PARAMETER

MODE

TYPE

DESCRIPTION

access_token

required

String

Access token obtained during authorization.

navigationPage

Optional

Number

Which page of results to return (default 1).

navigation PageSize

Optional

Number

Max records returned (default 100).


Data Schema

https://www.a4l.org/Resources/Documents/xPress_Roster-Data_Guidance.xls