Outcomes

Search Outcomes

get

https://lor.instructure.comhttps://lor-beta.instructure.comhttps://commons.eu-central.canvaslms.comhttps://commons-fra-beta.instructure.comhttps://commons.ca-central.canvaslms.comhttps://commons-yul-beta.instructure.comhttps://commons.sydney.canvaslms.comhttps://commons-syd-beta.instructure.comhttps://commons.singapore.canvaslms.comhttps://commons-sin-beta.instructure.com

/api/outcomes/query

Search academic outcomes to find standards to attach to a resource. Returns 20 outcomes at a time.

Example: curl -H "X-Session-ID: 0123456789" "https://lor.instructure.com/api/outcomes/query?query=Common&authority=UT&federal=true"

Authorizations

SessionAuth

x-session-idstringRequired

Session authentication. The session ID can be provided in any of the following ways: [Cookie: 'session'] [Header: 'x-session-id'] [Query parameter: 'session-id'] [Query parameter: first value of 'state'] [Body property: 'sessionId']

Query parameters

querystringRequired

The text to search for in the outcomes

authoritystringOptional

The comma separated authority codes for the outcomes being searched for. The authority code is the two letter state abbreviation, or "CC" for federal Common Core. Defaults to all authorities.

offsetintegerOptional

The offset the query results should start at. Used to paginate through the results. Defaults at 0.

Default: 0

Responses

200

An array of the results of the query

application/json

4XX

Bad Request

application/json

get

/api/outcomes/query

HTTPcURLJavaScriptPython

GET /api/outcomes/query?query=text HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Accept: */*

{
  "items": [
    {
      "guid": "text",
      "number": "text",
      "title": "text",
      "description": "text",
      "subjectDescription": "text"
    }
  ],
  "meta": {
    "count": 1,
    "offset": 1,
    "limit": 1
  }
}