Standards
The Standards resource can be used to access academic Standards and related metadata. The API provides a simple integration point, eliminates the need to manage Standards data in your organization and system, and provides the foundation for additional connected metadata. Use of the API ensures the most current Standards data is available to your application.
One of the greatest benefits of AB Connect is the ability to navigate relationships between Standards, other Standards and Topics. Retrieving the related Standards and Topics is done in a similar fashion as attributes, but they are contained in the JSON API relationships response. Note that due to the JSON API standard, only the type and ID are returned in the relationship data. Keep in mind that the JSON API ID is the same as the AB GUID for these entities. If you'd like to retrieve the data of the related resources, use the include parameter.
Standards can also be related to Assets. Note that if a Standard is related to an Asset, Topics related to that same Standard automatically become related to Asset as "predicted" relationships when you are licensed for the Academic Benchmarks Topic Taxonomy. Note that this implied relationship is bidirectional, so relating a Topic to an Asset directly also generates predicted Standards relationships. Relationships between Standards and Assets are managed through the Asset endpoint. See the documentation on the Asset endpoint for details.
All calls against the Standards resource must be implemented as HTTP GET requests, and must include proper Partner Authentication Credentials.
Single Standard
In its simplest form, you are able to retrieve the details of a specific Standard by appending the AB GUID to the path portion of the URL.
Fetching a Standard
get
Path parameters
guidstringRequired
guid of specified standard
Query parameters
partner.idstringRequired
Your partner ID - you should have gotten them from AB Support or when you signed up for a sandbox account.
auth.signaturestringRequired
Signature for the request authorization.
auth.expiresstringRequired
Expiration timestamp for the authorization.
fields[standards]stringOptional
comma separated list of field names
includestringOptional
A comma separated list of resource names that will be returned in the response. Standards have relationships with other resources (e.g. other Standards, Topics and Concepts). By default, those related resources are returned as references to other endpoints and only their IDs are included in the response. If you list the related resources by their relationship name in the include statement, the properties of the related resources are included as well.
Responses
200
OK
application/json
400
Bad Request
application/json
401
Authentication Error
application/json
404
Entity not found
application/json
get
GET /rest/v4.1/standards/{guid} HTTP/1.1
Host: api.abconnect.instructure.com
Accept: */*
{
"links": {
"self": "text"
},
"meta": {
"took": 1
},
"data": {
"type": "text",
"relationships": {
"related_courses": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"breakout_origins": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"ancestors": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"topics": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"peers": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"breakouts": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"crosswalks": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"replaced_by": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"replaces": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"children": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"concepts": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"derivatives": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"origins": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"peer_derivatives": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"parent": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"course_standards": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"contexts": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"associations": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
}
},
"attributes": {
"seq": 1,
"captured_by": "text",
"utilizations": [
{
"type": "alignable",
"guid": "text"
}
],
"uri": "text",
"statement": {
"addendums": [
{
"seq": 1,
"add_context": "Y",
"descr": "text",
"position": "before"
}
],
"combined_descr": "text",
"descr": "text"
},
"level": 1,
"date_modified_utc": "text",
"status": "active",
"legends": [
{
"symbol_position": "before",
"symbol": "text",
"descr": "text"
}
],
"standard_type": "organizational",
"label": "text",
"disciplines": {
"strands": [
{
"descr": "text",
"guid": "text"
}
],
"ece_domains": [
{
"guid": "text",
"code": "text",
"descr": "text"
}
],
"subjects": [
{
"code": "text",
"descr": "text",
"guid": "text"
}
],
"genres": [
{
"code": "text",
"guid": "text",
"descr": "text"
}
]
},
"alt_identifiers": [
{
"type": "GUID",
"source": "canonical",
"id": "text"
}
],
"date_deleted_utc": "text",
"in_list": "Y",
"guid": "text",
"key_ideas": [
{
"guid": "text",
"concepts": [
{
"descr": "text",
"guid": "text"
}
]
}
],
"document": {
"implementation_year": "text",
"descr": "text",
"date_modified_utc": "text",
"source_url": "text",
"assessment_year": "text",
"publication": {
"descr": "text",
"source_url": "text",
"extended_descr": "text",
"regions": [
{
"guid": "text",
"descr": "text",
"type": "country",
"code": "text"
}
],
"authorities": [
{
"guid": "text",
"descr": "text",
"acronym": "text"
}
],
"acronym": "text",
"publication_type": "standard",
"guid": "text"
},
"guid": "text",
"obsolete_year": "text",
"disciplines": {
"primary_subject": {
"code": "text",
"descr": "text",
"guid": "text"
}
},
"adopt_year": "text",
"revision_year": "text"
},
"deepest": "Y",
"number": {
"root_enhanced": "text",
"enhanced": "text",
"prefix_enhanced": "text",
"raw": "text"
},
"education_levels": {
"ece_ages": [
{
"guid": "text",
"descr": "text",
"seq": 1
}
],
"grades": [
{
"guid": "text",
"descr": "text",
"code": "text",
"seq": 1
}
]
},
"section": {
"guid": "text",
"seq": 1,
"date_modified_utc": "text",
"descr": "text",
"implementation_year": "text",
"number": "text",
"assessment_year": "text",
"revision_year": "text",
"label": "text",
"obsolete_year": "text",
"adopt_year": "text",
"disciplines": {
"primary_subject": {
"code": "text",
"descr": "text",
"guid": "text"
}
}
},
"extensions": [
{
"type": "reference",
"guid": "text",
"descr": "text"
}
],
"has_list": "text",
"topic_organizer": "text"
},
"id": "text"
},
"included": [
{
"type": "text",
"relationships": {
"related_courses": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"breakout_origins": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"ancestors": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"topics": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"peers": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"breakouts": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"crosswalks": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"replaced_by": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"replaces": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"children": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"concepts": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"derivatives": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"origins": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"peer_derivatives": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"parent": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"course_standards": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"contexts": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"associations": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
}
},
"attributes": {
"seq": 1,
"captured_by": "text",
"utilizations": [
{
"type": "alignable",
"guid": "text"
}
],
"uri": "text",
"statement": {
"addendums": [
{
"seq": 1,
"add_context": "Y",
"descr": "text",
"position": "before"
}
],
"combined_descr": "text",
"descr": "text"
},
"level": 1,
"date_modified_utc": "text",
"status": "active",
"legends": [
{
"symbol_position": "before",
"symbol": "text",
"descr": "text"
}
],
"standard_type": "organizational",
"label": "text",
"disciplines": {
"strands": [
{
"descr": "text",
"guid": "text"
}
],
"ece_domains": [
{
"guid": "text",
"code": "text",
"descr": "text"
}
],
"subjects": [
{
"code": "text",
"descr": "text",
"guid": "text"
}
],
"genres": [
{
"code": "text",
"guid": "text",
"descr": "text"
}
]
},
"alt_identifiers": [
{
"type": "GUID",
"source": "canonical",
"id": "text"
}
],
"date_deleted_utc": "text",
"in_list": "Y",
"guid": "text",
"key_ideas": [
{
"guid": "text",
"concepts": [
{
"descr": "text",
"guid": "text"
}
]
}
],
"document": {
"implementation_year": "text",
"descr": "text",
"date_modified_utc": "text",
"source_url": "text",
"assessment_year": "text",
"publication": {
"descr": "text",
"source_url": "text",
"extended_descr": "text",
"regions": [
{
"guid": "text",
"descr": "text",
"type": "country",
"code": "text"
}
],
"authorities": [
{
"guid": "text",
"descr": "text",
"acronym": "text"
}
],
"acronym": "text",
"publication_type": "standard",
"guid": "text"
},
"guid": "text",
"obsolete_year": "text",
"disciplines": {
"primary_subject": {
"code": "text",
"descr": "text",
"guid": "text"
}
},
"adopt_year": "text",
"revision_year": "text"
},
"deepest": "Y",
"number": {
"root_enhanced": "text",
"enhanced": "text",
"prefix_enhanced": "text",
"raw": "text"
},
"education_levels": {
"ece_ages": [
{
"guid": "text",
"descr": "text",
"seq": 1
}
],
"grades": [
{
"guid": "text",
"descr": "text",
"code": "text",
"seq": 1
}
]
},
"section": {
"guid": "text",
"seq": 1,
"date_modified_utc": "text",
"descr": "text",
"implementation_year": "text",
"number": "text",
"assessment_year": "text",
"revision_year": "text",
"label": "text",
"obsolete_year": "text",
"adopt_year": "text",
"disciplines": {
"primary_subject": {
"code": "text",
"descr": "text",
"guid": "text"
}
}
},
"extensions": [
{
"type": "reference",
"guid": "text",
"descr": "text"
}
],
"has_list": "text",
"topic_organizer": "text"
},
"id": "text"
}
]
}Searching for Standards
Using filtering and facets, it is possible to retrieve sets of Standards that match specific criteria. These Standards are returned in an array of Standard objects. See the Introduction for an explanation on filtering and the use of facets. This section covers the specifics of using these parameters with the Standards resource.
Finding Sets of Standards
get
Query parameters
partner.idstringRequired
Your partner ID - you should have gotten them from AB Support or when you signed up for a sandbox account.
auth.signaturestringRequired
Signature for the request authorization.
auth.expiresstringRequired
Expiration timestamp for the authorization.
fields[standards]stringOptional
comma separated list of field names
filter[standards]stringOptional
an ODATA-like query string used to filter
sort[standards]stringOptional
a comma separated list of property names specifying the sort order of the returned results
facetstringOptional
A comma separated list of facet names that you are requesting the options on.
facet_summarystringOptional
A comma separated list of facet names for which you are requesting summary information.
includestringOptional
A comma separated list of resource names that will be returned in the response.
limitnumberOptional
The page size for the response dataset. limit must be 100 or less.
offsetnumberOptional
How far into the dataset you are paging
Responses
200
OK
application/json
400
Bad Request
application/json
401
Authentication Error
application/json
get
GET /rest/v4.1/standards HTTP/1.1
Host: api.abconnect.instructure.com
Accept: */*
{
"links": {
"self": "text",
"first": "text",
"last": "text",
"next": "text",
"prev": "text"
},
"meta": {
"took": 1,
"limit": 1,
"count": 1,
"offset": 1,
"facets": [
{
"count": 1,
"facet": "text",
"details": [
{
"data": {
"descr": "text",
"code": "text",
"guid": "text"
},
"count": 1
}
]
}
]
},
"data": [
{
"type": "text",
"relationships": {
"related_courses": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"breakout_origins": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"ancestors": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"topics": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"peers": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"breakouts": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"crosswalks": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"replaced_by": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"replaces": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"children": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"concepts": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"derivatives": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"origins": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"peer_derivatives": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"parent": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"course_standards": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"contexts": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"associations": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
}
},
"attributes": {
"seq": 1,
"captured_by": "text",
"utilizations": [
{
"type": "alignable",
"guid": "text"
}
],
"uri": "text",
"statement": {
"addendums": [
{
"seq": 1,
"add_context": "Y",
"descr": "text",
"position": "before"
}
],
"combined_descr": "text",
"descr": "text"
},
"level": 1,
"date_modified_utc": "text",
"status": "active",
"legends": [
{
"symbol_position": "before",
"symbol": "text",
"descr": "text"
}
],
"standard_type": "organizational",
"label": "text",
"disciplines": {
"strands": [
{
"descr": "text",
"guid": "text"
}
],
"ece_domains": [
{
"guid": "text",
"code": "text",
"descr": "text"
}
],
"subjects": [
{
"code": "text",
"descr": "text",
"guid": "text"
}
],
"genres": [
{
"code": "text",
"guid": "text",
"descr": "text"
}
]
},
"alt_identifiers": [
{
"type": "GUID",
"source": "canonical",
"id": "text"
}
],
"date_deleted_utc": "text",
"in_list": "Y",
"guid": "text",
"key_ideas": [
{
"guid": "text",
"concepts": [
{
"descr": "text",
"guid": "text"
}
]
}
],
"document": {
"implementation_year": "text",
"descr": "text",
"date_modified_utc": "text",
"source_url": "text",
"assessment_year": "text",
"publication": {
"descr": "text",
"source_url": "text",
"extended_descr": "text",
"regions": [
{
"guid": "text",
"descr": "text",
"type": "country",
"code": "text"
}
],
"authorities": [
{
"guid": "text",
"descr": "text",
"acronym": "text"
}
],
"acronym": "text",
"publication_type": "standard",
"guid": "text"
},
"guid": "text",
"obsolete_year": "text",
"disciplines": {
"primary_subject": {
"code": "text",
"descr": "text",
"guid": "text"
}
},
"adopt_year": "text",
"revision_year": "text"
},
"deepest": "Y",
"number": {
"root_enhanced": "text",
"enhanced": "text",
"prefix_enhanced": "text",
"raw": "text"
},
"education_levels": {
"ece_ages": [
{
"guid": "text",
"descr": "text",
"seq": 1
}
],
"grades": [
{
"guid": "text",
"descr": "text",
"code": "text",
"seq": 1
}
]
},
"section": {
"guid": "text",
"seq": 1,
"date_modified_utc": "text",
"descr": "text",
"implementation_year": "text",
"number": "text",
"assessment_year": "text",
"revision_year": "text",
"label": "text",
"obsolete_year": "text",
"adopt_year": "text",
"disciplines": {
"primary_subject": {
"code": "text",
"descr": "text",
"guid": "text"
}
}
},
"extensions": [
{
"type": "reference",
"guid": "text",
"descr": "text"
}
],
"has_list": "text",
"topic_organizer": "text"
},
"id": "text"
}
],
"included": [
{
"type": "text",
"relationships": {
"related_courses": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"breakout_origins": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"ancestors": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"topics": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"peers": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"breakouts": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"crosswalks": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"replaced_by": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"replaces": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"children": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"concepts": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"derivatives": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"origins": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"peer_derivatives": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"parent": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"course_standards": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"contexts": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
},
"associations": {
"data": [
{
"type": "text",
"id": "text"
}
],
"links": {
"related": "text"
}
}
},
"attributes": {
"seq": 1,
"captured_by": "text",
"utilizations": [
{
"type": "alignable",
"guid": "text"
}
],
"uri": "text",
"statement": {
"addendums": [
{
"seq": 1,
"add_context": "Y",
"descr": "text",
"position": "before"
}
],
"combined_descr": "text",
"descr": "text"
},
"level": 1,
"date_modified_utc": "text",
"status": "active",
"legends": [
{
"symbol_position": "before",
"symbol": "text",
"descr": "text"
}
],
"standard_type": "organizational",
"label": "text",
"disciplines": {
"strands": [
{
"descr": "text",
"guid": "text"
}
],
"ece_domains": [
{
"guid": "text",
"code": "text",
"descr": "text"
}
],
"subjects": [
{
"code": "text",
"descr": "text",
"guid": "text"
}
],
"genres": [
{
"code": "text",
"guid": "text",
"descr": "text"
}
]
},
"alt_identifiers": [
{
"type": "GUID",
"source": "canonical",
"id": "text"
}
],
"date_deleted_utc": "text",
"in_list": "Y",
"guid": "text",
"key_ideas": [
{
"guid": "text",
"concepts": [
{
"descr": "text",
"guid": "text"
}
]
}
],
"document": {
"implementation_year": "text",
"descr": "text",
"date_modified_utc": "text",
"source_url": "text",
"assessment_year": "text",
"publication": {
"descr": "text",
"source_url": "text",
"extended_descr": "text",
"regions": [
{
"guid": "text",
"descr": "text",
"type": "country",
"code": "text"
}
],
"authorities": [
{
"guid": "text",
"descr": "text",
"acronym": "text"
}
],
"acronym": "text",
"publication_type": "standard",
"guid": "text"
},
"guid": "text",
"obsolete_year": "text",
"disciplines": {
"primary_subject": {
"code": "text",
"descr": "text",
"guid": "text"
}
},
"adopt_year": "text",
"revision_year": "text"
},
"deepest": "Y",
"number": {
"root_enhanced": "text",
"enhanced": "text",
"prefix_enhanced": "text",
"raw": "text"
},
"education_levels": {
"ece_ages": [
{
"guid": "text",
"descr": "text",
"seq": 1
}
],
"grades": [
{
"guid": "text",
"descr": "text",
"code": "text",
"seq": 1
}
]
},
"section": {
"guid": "text",
"seq": 1,
"date_modified_utc": "text",
"descr": "text",
"implementation_year": "text",
"number": "text",
"assessment_year": "text",
"revision_year": "text",
"label": "text",
"obsolete_year": "text",
"adopt_year": "text",
"disciplines": {
"primary_subject": {
"code": "text",
"descr": "text",
"guid": "text"
}
}
},
"extensions": [
{
"type": "reference",
"guid": "text",
"descr": "text"
}
],
"has_list": "text",
"topic_organizer": "text"
},
"id": "text"
}
]
}Last updated
Was this helpful?