Standards Resource

The standards resource is used to view, browse and search curriculum standards and other related data.  Standards data contained in the repository is continuously maintained by EdGate and refreshed regularly as updates are loaded.


Get a listing of available standards This endpoint is part of the Base package

View in API Navigator

This endpoint returns a listing of standards sets available in the client profile, identical to the data in the profile endpoint.

Request
GET /standards/

Response

This returns a list of Standards Set JSON objects

Table 2 - Standard Set object definition

Field Description Type
standards_sets A list of standards sets the profile has access to list
standards_sets.set_id An identifier for the standards set string
standards_sets.name Name of the standards set string
Standards_set.parent (optional) Name of the parent group the standards set belongs to string

Get data for an individual standard This endpoint is part of the Base package

View in API Navigator

This endpoint returns metadata about a single standard.

Request

GET /standards/{GUID}

Parameters

Field Description Location Type
GUID GUID of the standard to retrieve path string

Response

This returns a Standard JSON object

Table 3 - Standard object definition

Field Description Type
guid GUID of the standard string
set ID of the standards set the standard belongs to string
standard_number The numbering designation provided by the standards issuing authority string
standard_text The text of the standard string
label The leveling nomenclature for the standard string
depth The level depth of the standard integer
subject The general subject areas of the standard list
grade The grade levels of the standard list
adopted The year (and possibly month) the standard was adopted string
modified Timestamp of when the standard record was last modified in the EdGate repository timestamp (YYYY-MM-DD hh:mm:ss-TZ)
parent GUID of parent standard string
children List of GUIDs of child standards list
metadata Additional data about the standard List of metadata JSON objects
metadata.name Name of data field string
metadata.value Value of data field strng
correlated Status if the standard has correlated materials in the client's profile (only appears if "correlate" parameter is true) boolean

Get child standards for an individual standard This endpoint is part of the Base package

View in API Navigator

This endpoint returns a list of standards that occur immediately below a given standard in a hierarchy.  

Request

GET /standards/{GUID}/children

Parameters

Field Description Location Type
GUID GUID of the standard path string

Response

This returns a list of Standard JSON objects (see Table 3)


Get a list of standards from a specific set This endpoint is part of the Base package

View in API Navigator

This endpoint returns a listing of all standards in a specific set for a given subject area and grade.  This includes all parent and child level standards.

Request

GET /standards/list/{GUID}

Parameters

Field Description Location Type
GUID GUID of the standard path string
subject Subject area of standards Query string string
grade Grade level of standards Query string string
correlate Flag to show correlation status of the standards in response Query string boolean

Response

This returns a list of Standard JSON objects (see Table 3)


Get related standards This endpoint is part of the Base package

View in API Navigator

This endpoint finds other standards that are related to the standard GUID passed in.  This is useful for making comparisons across different sets of standards.

Request
GET /standards/related/{GUID}

Parameters

Field Description Location Type
GUID GUID of the standard path string
set ID of the standards set(s) you wish to see related data for.  Multiple sets can be passed in via comma separated list Query string string

Response

This returns a list of Standards Group object, grouped by standards set

Table 4 - Standards Group object

Field Description Type
sets Standards set information (see Table 2 for field definitions ) Standards set JSON object
standards List of standards objects (see table 3 for field definitions) list

Get a list of top level standards in a set This endpoint is part of the Base package

View in API Navigator

This endpoint is used to retrieve a list of the top (or root) level standards within a standards set hierarchy.  

Request
GET /standards/root/{set}

Parameters

Field Description Location Type
set ID of the standards set(s) you wish to see related data for.  Multiple sets can be passed in via comma separated list path string
subject Subject area of standards Query string string
grade Grade level of standards Query string string

Response

This returns a list of Standard JSON objects (see Table 3)


Search standards This endpoint is part of the Base package

View in API Navigator

Search the standards repository by term.  Result filtering is also available by standards set, subject area, and grade.  Defaults to 25 returned results with paging options available.

Request

GET /standards/search


Parameters

Field Description Location Type
q Search query text Query string string
set ID of the standards set to retrict results to Query string string
subject Subject area of standards Query string string
grade Grade level of standards Query string string
limit Number of results to return (default is 25) Query string integer
offset Numbering of record to begin the results at (used for paging) Query string integer

Response 

This returns a list of Standard JSON objects (see Table 3)

 


 

Export standards from a specific set This endpoint is part of the Standards Export package

View in API Navigator

This endpoint returns all standards for a specific standards set.  Can optionally export a single subject

Request

GET /standards/export/{set}(/{subject})

Parameters

Field Description Location Type
set ID of the standards set to export path string
subject Subject area of standards (optional) path string

Response

This returns a list of Standard JSON objects (see Table 3)


 

Get a list of updated standards sets for a date range This endpoint is part of the Base package

View in API Navigator

This endpoint returns a list of standards sets that have been updated within a given date range.  This includes notes of what the changes were. Results are limited to only those standards sets included in the client profile.

Request

GET /standards/updates

Parameters

Field Description Location Type
start Initial date to find updates from.  Required format: YYYY-MM-DD.  query string string
end End date to find updates that occurred before.  Required format: YYYY-MM-DD. If no end date is specified, the current date is used query string string
set ID of standards set to limit results to. (optional) query string string

Response

This returns a Standard Update Log JSON object

Table 4 - Standard object definition

Field Description Type
standards_set a standards set JSON object Object
standards_set.set_id ID of the standards set string
standars_set.name The name of the standards set string
standards_set.parent The name of the parent grouping of the standards set string
subject The subject area the update pertains to string
date The date of the update string
notes The reasoning for the update string