DHIS2 Agreements API

The agreements API from DHIS2 — 2 operation(s) for agreements.

GitHub OpenAPI

Operations 3

GET /agreements/v1/integrity_signature/{course_id} In order to check whether the user has signed the integrity agreement for a… #
POST /agreements/v1/integrity_signature/{course_id} Agreements v1 integrity signature create #
POST /agreements/v1/lti_pii_signature/{course_id} Agreements v1 lti pii signature create #

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-agreements-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-agreements-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Open edX Agreements 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: Agreements
paths:
  /agreements/v1/integrity_signature/{course_id}:
    parameters:
    - name: course_id
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: agreements_v1_integrity_signature_read
      summary: In order to check whether the user has signed the integrity agreement for a…
      description: 'Should return the following:

        username (str)

        course_id (str)

        created_at (str)


        If a username is not given, it should default to the requesting user (or masqueraded user).

        Only staff should be able to access this endpoint for other users.'
      responses:
        '200':
          description: ''
      tags:
      - Agreements
    post:
      operationId: agreements_v1_integrity_signature_create
      description: 'Create an integrity signature for the requesting user and course. If a signature

        already exists, returns the existing signature instead of creating a new one.


        /api/agreements/v1/integrity_signature/{course_id}


        Example response:

        {

        username: "janedoe",

        course_id: "org.2/course_2/Run_2",

        created_at: "2021-04-23T18:25:43.511Z"

        }'
      responses:
        '201':
          description: ''
      tags:
      - Agreements
      summary: Agreements v1 integrity signature create
      x-summary-source: derived
  /agreements/v1/lti_pii_signature/{course_id}:
    parameters:
    - name: course_id
      in: path
      required: true
      schema:
        type: string
    post:
      operationId: agreements_v1_lti_pii_signature_create
      description: 'Create an LTI PII signature for the requesting user and course. If a signature

        already exists, returns the existing signature instead of creating a new one.


        /api/agreements/v1/lti_pii_signature/{course_id}


        Example response:

        {

        username: "janedoe",

        course_id: "org.2/course_2/Run_2",

        created_at: "2021-04-23T18:25:43.511Z"

        }'
      responses:
        '201':
          description: ''
      tags:
      - Agreements
      summary: Agreements v1 lti pii signature create
      x-summary-source: derived
components:
  securitySchemes:
    Basic:
      type: http
      scheme: basic