Instructure Developer Documentation Portal

Grades Exchange API

PreviousInterop Data API NextOneRoster API

Last updated 1 year ago

Was this helpful?

Find a Grades Exchange by id

get

Get an Exchange

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": "course",
          "scope_by": "id",
          "scope_id": {
            "$sys": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "source_id": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "app_id": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "created_at": "2025-03-25T22:37:24.718Z",
              "updated_at": "2025-03-25T22:37:24.718Z"
            }
          },
          "graded_after": "2025-03-25T22:37:24.718Z",
          "summary_type": "final"
        }
      ]
    },
    "state": "created",
    "max_data_content_length": 1,
    "error_count": 1,
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-03-25T22:37:24.718Z",
    "updated_at": "2025-03-25T22:37:24.718Z"
  },
  "error": {
    "status": 1,
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}

Exchanges response

List Grades Exchange Errors

get

Get a list of Grades Exchange Errors

Authorizations

Path parameters

idstring · uuidrequired

id of the Exchange to list Errors

Query parameters

pageinteger · int32optional

Specify the page number (defaults to 0)

page_sizeinteger · int32optional

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-03-25T22:37:24.718Z",
      "updated_at": "2025-03-25T22:37:24.718Z",
      "code": "query_type_not_supported",
      "message": "text",
      "details": "text"
    }
  ],
  "paging": {
    "next": "text"
  }
}

Exchange Errors response

List Grades Exchanges

get

Get a list of Grades Exchanges

Authorizations

Query parameters

pageinteger · int32optional

Specify the page number (defaults to 0)

page_sizeinteger · int32optional

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": "course",
            "scope_by": "id",
            "scope_id": {
              "$sys": {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "source_id": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "app_id": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "created_at": "2025-03-25T22:37:24.718Z",
                "updated_at": "2025-03-25T22:37:24.718Z"
              }
            },
            "graded_after": "2025-03-25T22:37:24.718Z",
            "summary_type": "final"
          }
        ]
      },
      "state": "created",
      "max_data_content_length": 1,
      "error_count": 1,
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-03-25T22:37:24.718Z",
      "updated_at": "2025-03-25T22:37:24.718Z"
    }
  ],
  "paging": {
    "next": "text"
  }
}

Exchanges response

Create a Grades Exchange

post

Create a Grades Exchange

Authorizations

Body

queryobjectoptional

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": "course",
          "scope_by": "id",
          "scope_id": {
            "$sys": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "source_id": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "app_id": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "created_at": "2025-03-25T22:37:24.718Z",
              "updated_at": "2025-03-25T22:37:24.718Z"
            }
          },
          "graded_after": "2025-03-25T22:37:24.718Z",
          "summary_type": "final"
        }
      ]
    }
  }'

200

400

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-03-25T22:37:24.718Z",
    "updated_at": "2025-03-25T22:37:24.718Z"
  },
  "error": {
    "status": 1,
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}

Exchanges response

Create Grades Exchange Errors

post

Create a list of Grades Exchange Errors

Authorizations

Path parameters

idstring · uuidrequired

id of the Exchange to create Errors

Body

idstring · uuidread-onlyoptional

created_atstring · date-timeread-onlyoptional

updated_atstring · date-timeread-onlyoptional

codestring · enumoptional

Options: query_type_not_supported, query_conditions_not_supported, producer_error, producer_failure

messagestringread-onlyoptional

detailsstringoptional

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",
    "details": "text"
  }'

200

400

404

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-03-25T22:37:24.718Z",
    "updated_at": "2025-03-25T22:37:24.718Z",
    "code": "query_type_not_supported",
    "message": "text",
    "details": "text"
  },
  "paging": {
    "next": "text"
  }
}

Exchange Errors response

Create Grades Exchange Data

post

Create Grades data for an Exchange

Authorizations

Path parameters

idstring · uuidrequired

id of the Exchange to create Data

Body

assignmentsobject[]optional

summariesobject[]optional

finalbooleanoptional

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": [
      {
        "$sys": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "source_id": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "app_id": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "created_at": "2025-03-25T22:37:24.718Z",
          "updated_at": "2025-03-25T22:37:24.718Z"
        },
        "$section": {
          "$sys": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "source_id": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "app_id": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "created_at": "2025-03-25T22:37:24.718Z",
            "updated_at": "2025-03-25T22:37:24.718Z"
          }
        },
        "$category": {
          "name": "text",
          "$sys": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "source_id": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "app_id": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          }
        },
        "$term": {
          "$sys": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "source_id": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "app_id": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "created_at": "2025-03-25T22:37:24.718Z",
            "updated_at": "2025-03-25T22:37:24.718Z"
          }
        },
        "name": "text",
        "description": "text",
        "points_possible": 1,
        "due_at": "2025-03-25T22:37:24.718Z",
        "available_at": "2025-03-25T22:37:24.718Z",
        "$ext": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "scores": [
          {
            "$person": {
              "$sys": {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "source_id": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "app_id": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "created_at": "2025-03-25T22:37:24.718Z",
                "updated_at": "2025-03-25T22:37:24.718Z"
              }
            },
            "$grader": {
              "$sys": {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "source_id": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "app_id": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "created_at": "2025-03-25T22:37:24.718Z",
                "updated_at": "2025-03-25T22:37:24.718Z"
              }
            },
            "score": 1,
            "grade": "text",
            "late": true,
            "excused": true,
            "submitted_at": "2025-03-25T22:37:24.718Z",
            "preview_url": "text",
            "$ext": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          }
        ]
      }
    ],
    "summaries": [
      {
        "$section": {
          "$sys": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "source_id": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "app_id": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "created_at": "2025-03-25T22:37:24.718Z",
            "updated_at": "2025-03-25T22:37:24.718Z"
          }
        },
        "$person": {
          "$sys": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "source_id": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "app_id": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "created_at": "2025-03-25T22:37:24.718Z",
            "updated_at": "2025-03-25T22:37:24.718Z"
          }
        },
        "$grader": {
          "$sys": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "source_id": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "app_id": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "created_at": "2025-03-25T22:37:24.718Z",
            "updated_at": "2025-03-25T22:37:24.718Z"
          }
        },
        "summary_type": "midterm",
        "score_type": "raw",
        "score": 1,
        "grade": "text",
        "last_activity": "2025-03-25T22:37:24.718Z",
        "comments": [
          "text"
        ],
        "$ext": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ],
    "final": true
  }'

200

400

404

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-03-25T22:37:24.718Z",
    "updated_at": "2025-03-25T22:37:24.718Z"
  },
  "error": {
    "status": 1,
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}

Exchanges response

Find a Grades Exchange by id

List Grades Exchange Errors

List Grades Exchanges

Create a Grades Exchange

Show child attributes

Create Grades Exchange Errors

Create Grades Exchange Data

Show child attributes

Show child attributes