Common Core Search API Overview

Hello.
The users of Trails desired to tag their resources with standards from the Common Core, but there was no public API — so we built one, and we share it with you.

Trails.by offers two REST APIs to search the Common Core standards by grade and/or keyword and/or component, with a JSON object result.
  1. Use the Query API to search for summary information of matching standards.
  2. Use the Detail API to get detailed information on one specific standard.
  3. Check out the Full Example of a query call, result, detail call and detail result.
The Query API

Three parameters are allowed:'c', 'k', 'g', but only 'c' is required.

Ex: http://standards.trails.by/commoncore/q.php?c=math&k=triangle&g=6,7,8



The Detail API

One parameter is allowed and required: 'u', where the value of 'u' comes from a Query API call, as the 'url_final' property in the JSON object result.

Ex: http://standards.trails.by/commoncore/u.php?u=S114355A





Full Example

Case: Find standards for 6th grade math that involves triangles.

1. Query API call:

Ex: http://standards.trails.by/commoncore/q.php?c=math&k=triangle&g=6

2. Query API JSON result (with 'url_final' property highlighted) :
		
{
  "component": "math",
  "keywords": "triangle",
  "education levels": "6",
  "standards": [
    {
      "identity": "1312",
      "url_final": "S11434E2",
      "id": "http:\/\/asn.jesandco.org\/resources\/S11434E2",
      "asn_identitifier": "http:\/\/purl.org\/ASN\/resources\/S11434E2",
      "text": "Find the area of right triangles, other triangles, special quadrilaterals, and polygons by composing into rectangles or decomposing into triangles and other shapes; apply these techniques in the context of solving real-world and mathematical problems.",
      "asn_statementNotation": "CCSS.Math.Content.6.G.A.1",
      "asn_altStatementNotation": "6.G.1",
      "dcterms_educationLevel": "http:\/\/purl.org\/ASN\/scheme\/ASNEducationLevel\/6"
    },
    {
      "identity": "1315",
      "url_final": "S11434E5",
      "id": "http:\/\/asn.jesandco.org\/resources\/S11434E5",
      "asn_identitifier": "http:\/\/purl.org\/ASN\/resources\/S11434E5",
      "text": "Represent three-dimensional figures using nets made up of rectangles and triangles, and use the nets to find the surface area of these figures. Apply these techniques in the context of solving real-world and mathematical problems.",
      "asn_statementNotation": "CCSS.Math.Content.6.G.A.4",
      "asn_altStatementNotation": "6.G.4",
      "dcterms_educationLevel": "http:\/\/purl.org\/ASN\/scheme\/ASNEducationLevel\/6"
    }
  ]
}
3. Detail API: Get more specific detail on one of the standards, setting 'u' equal to the desired 'url_final' property from the Query API results.

Ex: http://standards.trails.by/commoncore/u.php?u=S11434E2

4. Detail API JSON result
		
{
  "url_final": "S11434E2",
  "valid": "true",
  "standard": {
    "identity": "1312",
    "component": "math",
    "url_final": "S11434E2",
    "id": "http:\/\/asn.jesandco.org\/resources\/S11434E2",
    "asn_identitifier": "http:\/\/purl.org\/ASN\/resources\/S11434E2",
    "text": "Find the area of right triangles, other triangles, special quadrilaterals, and polygons by composing into rectangles or decomposing into triangles and other shapes; apply these techniques in the context of solving real-world and mathematical problems.",
    "dcterms_description": [
      {
        "id": "1864",
        "literal": "Find the area of right triangles, other triangles, special quadrilaterals, and polygons by composing into rectangles or decomposing into triangles and other shapes; apply these techniques in the context of solving real-world and mathematical problems.",
        "language": "en-US"
      }
    ],
    "asn_authorityStatus": [
      {
        "id": "3393",
        "uri": "http:\/\/purl.org\/ASN\/scheme\/ASNAuthorityStatus\/Original",
        "preflabel": "Original Statement"
      }
    ],
    "dcterms_language": [
      {
        "id": "3390",
        "uri": "http:\/\/id.loc.gov\/vocabulary\/iso639-2\/eng",
        "preflabel": "English"
      }
    ],
    "asn_indexingStatus": [
      {
        "id": "3394",
        "uri": "http:\/\/purl.org\/ASN\/scheme\/ASNIndexingStatus\/Yes",
        "preflabel": "Yes"
      }
    ],
    "dcterms_subject": [
      {
        "id": "3395",
        "uri": "http:\/\/purl.org\/ASN\/scheme\/ASNTopic\/math",
        "preflabel": "Math"
      }
    ],
    "cls": "",
    "leaf": "1",
    "asn_statementNotation": "CCSS.Math.Content.6.G.A.1",
    "asn_statementLabel": [
      {
        "id": "811",
        "literal": "Standard",
        "language": "en-US"
      }
    ],
    "asn_altStatementNotation": "6.G.1",
    "asn_listID": "1.",
    "asn_uri": "http:\/\/asn.jesandco.org\/resources\/S11434E2",
    "dcterms_educationLevel": [
      {
        "id": "7",
        "uri": "http:\/\/purl.org\/ASN\/scheme\/ASNEducationLevel\/6",
        "preflabel": "6"
      }
    ],
    "skos_exactMatch": [
      {
        "id": "2492",
        "uri": "http:\/\/corestandards.org\/Math\/Content\/6\/G\/A\/1",
        "preflabel": "http:\/\/corestandards.org\/Math\/Content\/6\/G\/A\/1"
      },
      {
        "id": "2493",
        "uri": "urn:guid:1F31DD363906484D9D2779A34FB59610",
        "preflabel": "urn:guid:1F31DD363906484D9D2779A34FB59610"
      }
    ],
    "asn_localSubject": [
      
    ],
    "asn_comment": [
      
    ],
    "children": [
      
    ]
  }
}	


love,
the Trails for Education Team