Grades Exchange API

List Grades Exchanges

Get a list of Grades Exchanges

GEThttps://api.us2.kimonocloud.com/v2/grades/exchanges

Query parameters

Response

200

Exchanges response

Body

application/json

dataarray of Exchange (all of)

pagingobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.us2.kimonocloud.com/v2/grades/exchanges', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": [
    {
      "query": {
        "type": "assignment_scores",
        "conditions": [
          {
            "scope": "course",
            "scope_by": "id",
            "scope_id": {
              "$sys": {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "created_at": "2024-11-21T10:43:37.936Z",
                "updated_at": "2024-11-21T10:43:37.936Z"
              }
            },
            "graded_after": "2024-11-21T10:43:37.936Z",
            "summary_type": "final"
          }
        ]
      },
      "state": "created",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2024-11-21T10:43:37.936Z",
      "updated_at": "2024-11-21T10:43:37.936Z"
    }
  ],
  "paging": {
    "next": "text"
  }
}

Create a Grades Exchange

Create a Grades Exchange

POSThttps://api.us2.kimonocloud.com/v2/grades/exchanges

Body

application/json

Exchange to create

queryExchangeQuery (object)

Response

200400

Exchanges response

Body

application/json

dataBaseResourceType (object)

errorErrorType (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.us2.kimonocloud.com/v2/grades/exchanges', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2024-11-21T10:43:37.936Z",
    "updated_at": "2024-11-21T10:43:37.936Z"
  },
  "error": {
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}

Find a Grades Exchange by id

Get an Exchange

GEThttps://api.us2.kimonocloud.com/v2/grades/exchanges/{id}

Path parameters

id*string (uuid)

id of the Exchange to find

Response

200404

Exchanges response

Body

application/json

dataExchange (all of)

errorErrorType (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.us2.kimonocloud.com/v2/grades/exchanges/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": {
    "query": {
      "type": "assignment_scores",
      "conditions": [
        {
          "scope": "course",
          "scope_by": "id",
          "scope_id": {
            "$sys": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "created_at": "2024-11-21T10:43:37.936Z",
              "updated_at": "2024-11-21T10:43:37.936Z"
            }
          },
          "graded_after": "2024-11-21T10:43:37.936Z",
          "summary_type": "final"
        }
      ]
    },
    "state": "created",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2024-11-21T10:43:37.936Z",
    "updated_at": "2024-11-21T10:43:37.936Z"
  },
  "error": {
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}

List Grades Exchange Errors

Get a list of Grades Exchange Errors

GEThttps://api.us2.kimonocloud.com/v2/grades/exchanges/{id}/errors

Path parameters

id*string (uuid)

id of the Exchange to list Errors

Query parameters

Response

200404

Exchange Errors response

Body

application/json

dataarray of ExchangeError (object)

pagingobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.us2.kimonocloud.com/v2/grades/exchanges/{id}/errors', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2024-11-21T10:43:37.936Z",
      "updated_at": "2024-11-21T10:43:37.936Z",
      "code": "query_type_not_supported",
      "message": "text",
      "details": "text"
    }
  ],
  "paging": {
    "next": "text"
  }
}

Create Grades Exchange Errors

Create a list of Grades Exchange Errors

POSThttps://api.us2.kimonocloud.com/v2/grades/exchanges/{id}/errors

Path parameters

id*string (uuid)

id of the Exchange to create Errors

Body

application/json

Exchange to create

idstring (uuid)

created_atstring (date-time)

updated_atstring (date-time)

codeenum

query_type_not_supportedquery_conditions_not_supportedproducer_errorproducer_failure

messagestring

detailsstring

Response

200400404

Exchange Errors response

Body

application/json

dataExchangeError (object)

pagingobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.us2.kimonocloud.com/v2/grades/exchanges/{id}/errors', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2024-11-21T10:43:37.936Z",
    "updated_at": "2024-11-21T10:43:37.936Z",
    "code": "query_type_not_supported",
    "message": "text",
    "details": "text"
  },
  "paging": {
    "next": "text"
  }
}

Create Grades Exchange Data

Create Grades data for an Exchange

POSThttps://api.us2.kimonocloud.com/v2/grades/exchanges/{id}/data

Path parameters

id*string (uuid)

id of the Exchange to create Data

Body

application/json

Exchange Data to create

assignmentsarray of Assignment (object)

summariesarray of Summary (object)

finalboolean

Response

200400404

Exchanges response

Body

application/json

dataBaseResourceType (object)

errorErrorType (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.us2.kimonocloud.com/v2/grades/exchanges/{id}/data', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2024-11-21T10:43:37.936Z",
    "updated_at": "2024-11-21T10:43:37.936Z"
  },
  "error": {
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}