Instructure Developer Documentation Portal

Grades Exchange API

PreviousInterop Data API NextOneRoster API

Last updated 11 months ago

Was this helpful?

List Grades Exchanges

Get a list of Grades Exchanges

get

/exchanges

Authorizations

Query parameters

pageinteger · int32

Specify the page number (defaults to 0)

page_sizeinteger · int32

Specify the page_size (defaults to the maximum page size)

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/grades/exchanges'

200

{
  "data": [
    {
      "query": {
        "type": "assignment_scores",
        "conditions": [
          {
            "scope_id": {
              "$sys": {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "created_at": "2025-02-20T19:09:27.112Z",
                "updated_at": "2025-02-20T19:09:27.112Z",
                "source_id": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "app_id": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                }
              }
            },
            "graded_after": "2025-02-20T19:09:27.112Z",
            "scope": "course",
            "scope_by": "id",
            "summary_type": "final"
          }
        ]
      },
      "max_data_content_length": 1,
      "error_count": 1,
      "state": "created",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-02-20T19:09:27.112Z",
      "updated_at": "2025-02-20T19:09:27.112Z"
    }
  ],
  "paging": {
    "next": "text"
  }
}

Exchanges response

Create a Grades Exchange

post

/exchanges

Authorizations

Body

queryobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.us2.kimonocloud.com/v2/grades/exchanges' \
  --header 'Content-Type: application/json' \
  --data '{"query":{"type":"assignment_scores","conditions":[{"scope_id":{"$sys":{"id":"123e4567-e89b-12d3-a456-426614174000","created_at":"2025-02-20T19:09:27.112Z","updated_at":"2025-02-20T19:09:27.112Z","source_id":{"ANY_ADDITIONAL_PROPERTY":"text"},"app_id":{"ANY_ADDITIONAL_PROPERTY":"text"}}},"graded_after":"2025-02-20T19:09:27.112Z","scope":"course","scope_by":"id","summary_type":"final"}]}}'

200

400

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-02-20T19:09:27.112Z",
    "updated_at": "2025-02-20T19:09:27.112Z"
  },
  "error": {
    "status": 1,
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}

Exchanges response

Find a Grades Exchange by id

Get an Exchange

get

/exchanges/{id}

Authorizations

Path parameters

idstring · uuidrequired

id of the Exchange to find

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/grades/exchanges/{id}'

200

404

{
  "data": {
    "query": {
      "type": "assignment_scores",
      "conditions": [
        {
          "scope_id": {
            "$sys": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "created_at": "2025-02-20T19:09:27.112Z",
              "updated_at": "2025-02-20T19:09:27.112Z",
              "source_id": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "app_id": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              }
            }
          },
          "graded_after": "2025-02-20T19:09:27.112Z",
          "scope": "course",
          "scope_by": "id",
          "summary_type": "final"
        }
      ]
    },
    "max_data_content_length": 1,
    "error_count": 1,
    "state": "created",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-02-20T19:09:27.112Z",
    "updated_at": "2025-02-20T19:09:27.112Z"
  },
  "error": {
    "status": 1,
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}

Exchanges response

List Grades Exchange Errors

Get a list of Grades Exchange Errors

get

/exchanges/{id}/errors

Authorizations

Path parameters

idstring · uuidrequired

id of the Exchange to list Errors

Query parameters

pageinteger · int32

Specify the page number (defaults to 0)

page_sizeinteger · int32

Specify the page_size (defaults to the maximum page size)

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/grades/exchanges/{id}/errors'

200

404

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-02-20T19:09:27.112Z",
      "updated_at": "2025-02-20T19:09:27.112Z",
      "message": "text",
      "details": "text",
      "code": "query_type_not_supported"
    }
  ],
  "paging": {
    "next": "text"
  }
}

Exchange Errors response

Create Grades Exchange Errors

Create a list of Grades Exchange Errors

post

/exchanges/{id}/errors

Authorizations

Path parameters

idstring · uuidrequired

id of the Exchange to create Errors

Body

idstring · uuid

created_atstring · date-time

updated_atstring · date-time

messagestring

detailsstring

codestring · enum

Options: query_type_not_supported, query_conditions_not_supported, producer_error, producer_failure

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.us2.kimonocloud.com/v2/grades/exchanges/{id}/errors' \
  --header 'Content-Type: application/json' \
  --data '{"code":"query_type_not_supported"}'

200

400

404

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-02-20T19:09:27.112Z",
    "updated_at": "2025-02-20T19:09:27.112Z",
    "message": "text",
    "details": "text",
    "code": "query_type_not_supported"
  },
  "paging": {
    "next": "text"
  }
}

Exchange Errors response

Create Grades Exchange Data

Create Grades data for an Exchange

post

/exchanges/{id}/data

Authorizations

Path parameters

idstring · uuidrequired

id of the Exchange to create Data

Body

finalboolean

assignmentsobject[]

summariesobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.us2.kimonocloud.com/v2/grades/exchanges/{id}/data' \
  --header 'Content-Type: application/json' \
  --data '{"assignments":[{"$section":{"$sys":{"id":"123e4567-e89b-12d3-a456-426614174000","created_at":"2025-02-20T19:09:27.112Z","updated_at":"2025-02-20T19:09:27.112Z","source_id":{"ANY_ADDITIONAL_PROPERTY":"text"},"app_id":{"ANY_ADDITIONAL_PROPERTY":"text"}}},"$category":{"$sys":{"source_id":{"ANY_ADDITIONAL_PROPERTY":"text"},"app_id":{"ANY_ADDITIONAL_PROPERTY":"text"}}},"$term":{"$sys":{"id":"123e4567-e89b-12d3-a456-426614174000","created_at":"2025-02-20T19:09:27.112Z","updated_at":"2025-02-20T19:09:27.112Z","source_id":{"ANY_ADDITIONAL_PROPERTY":"text"},"app_id":{"ANY_ADDITIONAL_PROPERTY":"text"}}},"$ext":{},"scores":[{"$person":{"$sys":{"id":"123e4567-e89b-12d3-a456-426614174000","created_at":"2025-02-20T19:09:27.112Z","updated_at":"2025-02-20T19:09:27.112Z","source_id":{"ANY_ADDITIONAL_PROPERTY":"text"},"app_id":{"ANY_ADDITIONAL_PROPERTY":"text"}}},"$grader":{"$sys":{"id":"123e4567-e89b-12d3-a456-426614174000","created_at":"2025-02-20T19:09:27.112Z","updated_at":"2025-02-20T19:09:27.112Z","source_id":{"ANY_ADDITIONAL_PROPERTY":"text"},"app_id":{"ANY_ADDITIONAL_PROPERTY":"text"}}},"$ext":{}}],"$sys":{"source_id":{},"app_id":{}}}],"summaries":[{"$section":{"$sys":{"id":"123e4567-e89b-12d3-a456-426614174000","created_at":"2025-02-20T19:09:27.112Z","updated_at":"2025-02-20T19:09:27.112Z","source_id":{"ANY_ADDITIONAL_PROPERTY":"text"},"app_id":{"ANY_ADDITIONAL_PROPERTY":"text"}}},"$person":{"$sys":{"id":"123e4567-e89b-12d3-a456-426614174000","created_at":"2025-02-20T19:09:27.112Z","updated_at":"2025-02-20T19:09:27.112Z","source_id":{"ANY_ADDITIONAL_PROPERTY":"text"},"app_id":{"ANY_ADDITIONAL_PROPERTY":"text"}}},"$grader":{"$sys":{"id":"123e4567-e89b-12d3-a456-426614174000","created_at":"2025-02-20T19:09:27.112Z","updated_at":"2025-02-20T19:09:27.112Z","source_id":{"ANY_ADDITIONAL_PROPERTY":"text"},"app_id":{"ANY_ADDITIONAL_PROPERTY":"text"}}},"$ext":{},"summary_type":"midterm","score_type":"raw","comments":[null]}]}'

200

400

404

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-02-20T19:09:27.112Z",
    "updated_at": "2025-02-20T19:09:27.112Z"
  },
  "error": {
    "status": 1,
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}

Exchanges response