List schools

Returns a page of schools that are supported by NSC.

The codes originating from National Student Clearinghouse

Request
query Parameters
name
string

If set, the items will be filtered on schools with the specified name.

code
string

If set, the items will be filtered on schools with the specified code.

count
integer <int32> [ 1 .. 1000 ]

The number of items to include in a single page.

sortedBy
string

The property by which the returned data will be sorted.

Enum: "Name" "Code"
object

If set, the properties and directions the returned data will be sorted by.

offset
integer <int32>
Deprecated

The offset for the page to start.

cursor
string

The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically.

sortDirection
string

The direction the returned data will be sorted by.

Enum: "Asc" "Desc"
Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Error

get/datasets/nsc/schoolCodes
Response samples
application/json
{
  • "sort": {
    },
  • "previousCursor": "string",
  • "nextCursor": "string",
  • "nextOffset": 0,
  • "pageSize": 0,
  • "count": 0,
  • "totalCount": 0,
  • "items": [
    ],
  • "sortedBy": "Name",
  • "sortDirection": "Asc"
}