Crosswalk API

Crosswalk API takes as input list of standards display codes and a target framework to crosswalk to. API does the crosswalk of input standard codes to equivalent framework codes and returns the same. If there is no equivalent of input standard code in the specified target framework, returns null.

This endpoint would be available to anonymous users as well. But the API still requires a valid access_token presented via request header (either anonymous token or authenticated user token).

Since the request payload (list of standard codes as input) could be huge, this API is a HTTP POST method.

API End Point
{REST_END_POINT}/api/nucleus/v2/taxonomy/crosswalk/fw

Method Type
POST

Request Headers

Header	Value	Description
Authorization	Token {TOKEN}	Replace the {TOKEN} with actual value of access_token obtained from authentication.

Request Body

Key	Data Type	Value	Description
codes	JSON Array	ARRAY OF DISPLAY CODES	Standards display codes that need to be crosswalked
target_framework_id	String	TARGET FRAMEWORK CODE	Target Framework to crosswalk to based on input standards.

Sample Call

Curl -i -H "Authorization:Token MTQ3NDM1NDIzMDk1OTowMjE5MDkwYy1hYmU2LTRhMDktOGM5Zi0zNDM5MTFmNWNkODY6YmE5NTZhOTctYWUxNS0xMWU1LWEzMDItZjhhOTYzMDY1OTc" -XPOST ‘http://gooru.org/api/nucleus/v2/taxonomy/crosswalk/fw’ -d ‘{
"codes":[
   "CCSS.K12.MA-1-G-A",
   "CCSS.K12.MA-1-MA-A",
   "CCSS.K12.MA-1-SA-A"
 ],
"target_framework_id":"TEXAS"
}’

Response Structure

Key	Data Type	Description
.code	String	Display code of input standard at the crosswalked / target framework.
.title	String	Display title of input standard at the crosswalked / target framework.
.description	String	Description of input standard at the crosswalked / target framework.

Sample Response

{ 
   "CCSS.K12.MA-1-G-A":{ 
      "code":"MA-1-G",
      "title":"Math grade 1 Shapes",
      "description":""
   },
   "CCSS.K12.MA-1-MA-A":{ 
      "code":"MA-1-MA",
      "title":"Math grade 1 Counting",
      "description":""
   },
   "CCSS.K12.MA-1-SA-A":null
}