DHIS2 Lti Consumer API

The lti_consumer API from DHIS2 — 6 operation(s) for lti_consumer.

GitHub OpenAPI

Operations 10

GET /lti_consumer/v1/lti/{lti_config_id}/lti-ags LineItem endpoint implementation from LTI Advantage #
POST /lti_consumer/v1/lti/{lti_config_id}/lti-ags LineItem endpoint implementation from LTI Advantage #
GET /lti_consumer/v1/lti/{lti_config_id}/lti-ags/{id} LineItem endpoint implementation from LTI Advantage #
PUT /lti_consumer/v1/lti/{lti_config_id}/lti-ags/{id} LineItem endpoint implementation from LTI Advantage #
PATCH /lti_consumer/v1/lti/{lti_config_id}/lti-ags/{id} LineItem endpoint implementation from LTI Advantage #
DELETE /lti_consumer/v1/lti/{lti_config_id}/lti-ags/{id} LineItem endpoint implementation from LTI Advantage #
GET /lti_consumer/v1/lti/{lti_config_id}/lti-ags/{id}/results/{user_id} Return a Result list for an LtiAgsLineItem #
POST /lti_consumer/v1/lti/{lti_config_id}/lti-ags/{id}/scores Lti consumer v1 lti lti ags scores #
GET /lti_consumer/v1/lti/{lti_config_id}/memberships Lti consumer v1 lti memberships list #
GET /lti_consumer/v1/lti/{lti_config_id}/memberships/{id} LTI NRPS Context Membership Service endpoint #

Specifications

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/dhis2:dhis2-lti-consumer-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

dhis2-lti-consumer-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Open edX Lti Consumer API
  description: APIs for access to Open edX information
  contact:
    email: contact@academy.dhis2.org
  version: v1
servers:
- url: https://academy.dhis2.org/api
security:
- Basic: []
tags:
- name: lti_consumer
paths:
  /lti_consumer/v1/lti/{lti_config_id}/lti-ags:
    parameters:
    - name: lti_config_id
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: lti_consumer_v1_lti_lti-ags_list
      summary: LineItem endpoint implementation from LTI Advantage
      description: 'See full documentation at:'
      responses:
        '200':
          description: ''
          content:
            application/vnd.ims.lis.v2.lineitemcontainer+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LtiAgsLineItem'
            application/vnd.ims.lis.v2.lineitem+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LtiAgsLineItem'
      tags:
      - lti_consumer
    post:
      operationId: lti_consumer_v1_lti_lti-ags_create
      summary: LineItem endpoint implementation from LTI Advantage
      description: 'See full documentation at:'
      responses:
        '201':
          description: ''
          content:
            application/vnd.ims.lis.v2.lineitemcontainer+json:
              schema:
                $ref: '#/components/schemas/LtiAgsLineItem'
            application/vnd.ims.lis.v2.lineitem+json:
              schema:
                $ref: '#/components/schemas/LtiAgsLineItem'
      tags:
      - lti_consumer
      requestBody:
        content:
          application/vnd.ims.lis.v2.lineitem+json:
            schema:
              $ref: '#/components/schemas/LtiAgsLineItem'
        required: true
  /lti_consumer/v1/lti/{lti_config_id}/lti-ags/{id}:
    parameters:
    - name: lti_config_id
      in: path
      required: true
      schema:
        type: string
    - name: id
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: lti_consumer_v1_lti_lti-ags_read
      summary: LineItem endpoint implementation from LTI Advantage
      description: 'See full documentation at:'
      responses:
        '200':
          description: ''
          content:
            application/vnd.ims.lis.v2.lineitemcontainer+json:
              schema:
                $ref: '#/components/schemas/LtiAgsLineItem'
            application/vnd.ims.lis.v2.lineitem+json:
              schema:
                $ref: '#/components/schemas/LtiAgsLineItem'
      tags:
      - lti_consumer
    put:
      operationId: lti_consumer_v1_lti_lti-ags_update
      summary: LineItem endpoint implementation from LTI Advantage
      description: 'See full documentation at:'
      responses:
        '200':
          description: ''
          content:
            application/vnd.ims.lis.v2.lineitemcontainer+json:
              schema:
                $ref: '#/components/schemas/LtiAgsLineItem'
            application/vnd.ims.lis.v2.lineitem+json:
              schema:
                $ref: '#/components/schemas/LtiAgsLineItem'
      tags:
      - lti_consumer
      requestBody:
        content:
          application/vnd.ims.lis.v2.lineitem+json:
            schema:
              $ref: '#/components/schemas/LtiAgsLineItem'
        required: true
    patch:
      operationId: lti_consumer_v1_lti_lti-ags_partial_update
      summary: LineItem endpoint implementation from LTI Advantage
      description: 'See full documentation at:'
      responses:
        '200':
          description: ''
          content:
            application/vnd.ims.lis.v2.lineitemcontainer+json:
              schema:
                $ref: '#/components/schemas/LtiAgsLineItem'
            application/vnd.ims.lis.v2.lineitem+json:
              schema:
                $ref: '#/components/schemas/LtiAgsLineItem'
      tags:
      - lti_consumer
      requestBody:
        content:
          application/vnd.ims.lis.v2.lineitem+json:
            schema:
              $ref: '#/components/schemas/LtiAgsLineItem'
        required: true
    delete:
      operationId: lti_consumer_v1_lti_lti-ags_delete
      summary: LineItem endpoint implementation from LTI Advantage
      description: 'See full documentation at:'
      responses:
        '204':
          description: ''
      tags:
      - lti_consumer
  /lti_consumer/v1/lti/{lti_config_id}/lti-ags/{id}/results/{user_id}:
    parameters:
    - name: lti_config_id
      in: path
      required: true
      schema:
        type: string
    - name: id
      in: path
      required: true
      schema:
        type: string
    - name: user_id
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: lti_consumer_v1_lti_lti-ags_results
      summary: Return a Result list for an LtiAgsLineItem
      description: 'URL Parameters:

        * user_id (string): String external user id representation.


        Query Parameters:

        * limit (integer): The maximum number of records to return. Records are

        sorted with most recent timestamp first'
      responses:
        '200':
          description: ''
          content:
            application/vnd.ims.lis.v2.resultcontainer+json:
              schema:
                $ref: '#/components/schemas/LtiAgsLineItem'
      tags:
      - lti_consumer
  /lti_consumer/v1/lti/{lti_config_id}/lti-ags/{id}/scores:
    parameters:
    - name: lti_config_id
      in: path
      required: true
      schema:
        type: string
    - name: id
      in: path
      required: true
      schema:
        type: string
    post:
      operationId: lti_consumer_v1_lti_lti-ags_scores
      description: Create a Score record for an LtiAgsLineItem
      responses:
        '201':
          description: ''
          content:
            application/vnd.ims.lis.v1.score+json:
              schema:
                $ref: '#/components/schemas/LtiAgsLineItem'
      tags:
      - lti_consumer
      requestBody:
        content:
          application/vnd.ims.lis.v1.score+json:
            schema:
              $ref: '#/components/schemas/LtiAgsLineItem'
        required: true
      summary: Lti consumer v1 lti lti ags scores
      x-summary-source: derived
  /lti_consumer/v1/lti/{lti_config_id}/memberships:
    parameters:
    - name: lti_config_id
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: lti_consumer_v1_lti_memberships_list
      description: 'Overrides default list method of ModelViewSet. Calls LMS `get_course_members`

        API and returns result.'
      parameters:
      - name: page
        in: query
        description: A page number within the paginated result set.
        required: false
        schema:
          type: integer
      - name: page_size
        in: query
        description: Number of results to return per page.
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: ''
      tags:
      - lti_consumer
      summary: Lti consumer v1 lti memberships list
      x-summary-source: derived
  /lti_consumer/v1/lti/{lti_config_id}/memberships/{id}:
    parameters:
    - name: lti_config_id
      in: path
      required: true
      schema:
        type: string
    - name: id
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: lti_consumer_v1_lti_memberships_read
      summary: LTI NRPS Context Membership Service endpoint
      description: 'See full documentation at:'
      responses:
        '200':
          description: ''
      tags:
      - lti_consumer
components:
  schemas:
    LtiAgsLineItem:
      required:
      - resourceId
      - scoreMaximum
      - label
      type: object
      properties:
        id:
          title: Id
          type: string
          readOnly: true
        resourceId:
          title: Resourceid
          type: string
          minLength: 1
        scoreMaximum:
          title: Scoremaximum
          type: integer
        label:
          title: Label
          type: string
          maxLength: 100
          minLength: 1
        tag:
          title: Tag
          type: string
          maxLength: 50
        resourceLinkId:
          title: Resourcelinkid
          type: string
        startDateTime:
          title: Startdatetime
          type: string
          format: date-time
        endDateTime:
          title: Enddatetime
          type: string
          format: date-time
  securitySchemes:
    Basic:
      type: http
      scheme: basic