API docs by Redocly

Satchel Rosetta Alignment Services API (1.0.0)

Download OpenAPI specification:Download

A specialized API for users of Satchel Rosetta Alignment Services from Common Good Learning Tools, facilitating bidirectional alignments between educational resources and learning standards (aka competencies) using the CASE® (Competencies and Academic Standards Exchange) format.

View the full Rosetta Exchange Integration Guide

Suggest Learning Standards for Educational Resources

For any given educational resource or set of resources, request suggestions for learning standards (competencies) that may align to each resource.

Request Body schema: application/json
required
required
Array of ResourceFrameworkItem (object) or ResourceAdHocItem (object)

Specifies the set of resources you want to request alignment suggestions for.

  • Note that you must specify either a single “ResourceFrameworkItem”, which defines a set of resources coded in a CASE framework, or and array of “ResourceAdHocItems”, each of which explicitly states the metadata for a single resource.
required
Array of objects (CompetencyUniverseItem)

Specifies the set of standards/competencies you want to consider as possible alignments for each resource.

  • Note that each object in this array specifies a set of competencies for one CASE framework; specify multiple objects to get standard alignment suggestions for multiple frameworks in a single API request.
searchTerms
string

If provided, the meaning match between the searchTerms and each competency will be taken into account along with the match between the resource and the competency.

educationLevelMatchTolerance
number

If provided and >= 0, competency suggestions will only be returned for resource-competency combinations where a) both the resource and competency have educationLevel specified, and b) the "difference" between the educationLevels is <= educationLevelMatchTolerance

matchCountToReturn
integer
Default: 20

Number of suggested competencies to suggest for each resource

returnedCFItemData
string
Default: "identifier"
Enum: "identifier" "all" "base"

Specifies the the CASE metadata returned for each suggested alignment.

  • identifier (Default): Returns only the competency’s frameworkIdentifier and itemIdentifier. * all: Returns the core identifiers plus a CFItem object containing the complete set of CASE metadata available for the competency. * base: Returns core identifiers and a CFItem object containing only the following subset of fields: identifier, fullStatement, humanCodingScheme, CFItemType, educationLevel, and lastChangeDateTime.

Responses

Response Schema: application/json
status
string

If successful, "ok"; otherwise a description of the encountered error.

Array of objects or objects or objects (ReturnedResourceArray) [ items ]

Array of results, one for each resource specified in the requested resourceUniverse.

  • Note that the return value here is an array of arrays: for each resource specified in the resourceUniverse, you get back one array for each CASE framework specified in the competencyUniverse.

Request samples

Content type
application/json
{
  • "resourceUniverse": [
    ],
  • "competencyUniverse": [
    ],
  • "searchTerms": "string",
  • "educationLevelMatchTolerance": 0,
  • "matchCountToReturn": 20,
  • "returnedCFItemData": "identifier"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "resources": [
    ]
}

Suggest Educational Resources for Learning Standards

For any given learning standard (competency) or set of standards, request suggestions for educational resources that may align to each standard.

Request Body schema: application/json
required
required
Array of objects (CompetencyUniverseItem)

Specifies the set of standards/competencies you want to request resource suggestions for.

  • Note that each object in this array specifies a set of competencies for one CASE framework; specify multiple objects to get resource suggestions for multiple frameworks in a single API request.
required
Array of ResourceFrameworkItem (object) or ResourceAdHocItem (object)

Specifies the set of resources you want to draw suggestions from for each competency.

  • Note that you must specify either a single “ResourceFrameworkItem”, which defines a set of resources coded in a CASE framework, or and array of “ResourceAdHocItems”, each of which explicitly states the metadata for a single resource.
searchTerms
string

If provided, the meaning match between the searchTerms and each resource will be taken into account along with the match between the competency and the resource.

educationLevelMatchTolerance
number

If provided and >= 0, resource suggestions will only be returned for competency-resource combinations where a) both the competency and resource have educationLevel specified, and b) the "difference" between the educationLevels is <= educationLevelMatchTolerance

matchCountToReturn
integer
Default: 20

Number of suggested resources to suggest for each competency

Responses

Response Schema: application/json
Array
status
string

If successful, "ok"; otherwise a description of the encountered error.

Array of objects or objects or objects (ReturnedCompetencySuggestion)

Array of results, one for each competency specified in the requested competencyUniverse

  • Note that the return value here is an array of objects: for each competency specified in the competencyUniverse, you get back one array for each resource specified in the resourceUniverse.

Request samples

Content type
application/json
{
  • "competencyUniverse": [
    ],
  • "resourceUniverse": [
    ],
  • "searchTerms": "string",
  • "educationLevelMatchTolerance": 0,
  • "matchCountToReturn": 20
}

Response samples

Content type
application/json
[
  • {
    }
]