Concepts Resource

The concept resource provides endpoints for accessing EdGate's Concept Index.  The Concept Index is used to create alignments bewteen content and standards.

Search concepts This endpoint is part of the Premium II package

View in API Navigator

Search concepts. Defaults to 25 returned results with paging options available.

 

Request

GET /concepts/


Parameters

Field Description Location Type
q Search query text Query string string
limit The 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 Concept Search Result JSON object (see Table 11)

 

Table 11 - Concept Search Result JSON object

Field Description Type
status Status object Status JSON object
status.code Response code integer
status.message Status message text string
resultcount Number of total search results integer
offset Numeric index of the starting record in the result set integer
limit The number of results returned in the response integer
results Result set for the search List of Concept objects (see Table 12 for definition)

 

Table 12 - Concept object

Field Description Type
guid GUID of concept string
name Name of concept string
parent Object describing the parnet concept string
parent.guid GUID of parnet concept string
parent.name Name of parent concept string
children GUIDs of child concepts List (string)

 

 

Get concept by GUID This endpoint is part of the Premium II package

View in API Navigator

Get a concept by its GUID

 

Request

GET /concepts/{GUID}


Parameters

Field Description Location Type
GUID GUID of the concept Path string

 

Response

This returns a Concept object (see Table 12)

 

 

 

Browse top level of concept index This endpoint is part of the Premium II package

View in API Navigator

This endpoint returns a list of all top level node in the concept index

 

Request

GET /concepts/browse

 

Response

The response contains a list of Concept JSON objects. (See Table 12)

 

 

Get child concepts This endpoint is part of the Premium II package

View in API Navigator

Retrieve all child concepts for a specific concept GUID

 

Request

GET /concepts/browse/{GUID}

 

Parameters

Field Description Location Type
GUID GUID of the concept path string

 

Response

This endpoint returns a list of concept objects (See Table 12)

 

 

Get standards tagged with concept This endpoint is part of the Premium II package

View in API Navigator

This endpoint will retrieve standards that are tagged with a specific concept

 

Request

GET /concepts/standards/{GUID}

 

Parameters

Field Description Location Type
GUID GUID of concept path string
set ID of standards set to get standards for query string string
grade grade level of standards query string string

 

Response

This endpoint returns a list of Standards Group objects. (See Table 4)

 

 

Get content tagged with concept This endpoint is part of the Premium II package

View in API Navigator

This endpoint retrieves content items tagged with a specific concept

 

Request

GET /concepts/content/{GUID}

 

Parameters

Field Description Location Type
GUID GUID of concept path string
filters Comma separated list of name/value pairs.  Field name and value are delimited with a pipe character “|”.  Available filter fields and values can be found via the /content/filters endpoint. query string string
limit The 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 endpoint returns a Content Result object (See Table 5)

 

 

Suggest concepts based on item metadata This endpoint is part of the Premium II package

View in API Navigator

This endpoint will suggest concepts for a specific content item, based on it metdata

 

Request

GET /concepts/suggest/{GUID}

 

Parameters

Field Description Location Type
GUID GUID of content item path string
fields Comma separated list of data fields to use as basis of suggestion.  Default is "title".  "description" and any other field defined in the /content/filters endpoint are accepted. query string string
useconcepts Use existing concepts already tagged to item as basis for suggestion.  Ignores any values passed in the fields parameter if set to "true" query string boolean
limit The number of concepts to return (default is 10) query string integer
scope Scope of precision to use in making suggestion.  Scale from 1-10 (default is 5).  1 is the most precise, using the most relevant source data, but yielding less results.  The higher the value, the larger the number of possible suggestions, but at the cost of being less relevant. query string integer

 

Response

This endpoint returns a list of concept objects (See Table 12)

 

 

Suggest concepts based on terms This endpoint is part of the Premium II package

View in API Navigator

This endpoint will suggest concepts based on a string

 

Request

GET /concepts/suggest/

 

Parameters

Field Description Location Type
q String to use as basis for suggestion Query string string
limit The number of concepts to return (default is 10) query string integer
scope Scope of precision to use in making suggestion.  Scale from 1-10 (default is 5).  1 is the most precise, using the most relevant source data, but yielding less results.  The higher the value, the larger the number of possible suggestions, but at the cost of being less relevant. query string integer

 

Response

This returns a list of Concept objects (See Table 12)

 

 

Get related concepts This endpoint is part of the Premium II package

View in API Navigator

Retrieve related concepts for a specific concept GUID

 

Request

GET /concepts/related/{GUID}

 

Parameters

Field Description Location Type
GUID GUID of the concept path string

 

Response

This endpoint returns a list of concept objects (See Table 12)