Grades Exchange API

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

all ofoptional

get

HTTPcURLJavaScriptPython

GET /v2/grades/exchanges HTTP/1.1
Host: api.us2.kimonocloud.com
Accept: */*

200

Exchanges response

{
  "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-04-15T03:09:55.829Z",
                "updated_at": "2025-04-15T03:09:55.829Z"
              }
            },
            "graded_after": "2025-04-15T03:09:55.829Z",
            "summary_type": "final"
          }
        ]
      },
      "state": "created",
      "max_data_content_length": 1,
      "error_count": 1,
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-04-15T03:09:55.829Z",
      "updated_at": "2025-04-15T03:09:55.829Z"
    }
  ],
  "paging": {
    "next": "text"
  }
}

Create a Grades Exchange

post

Create a Grades Exchange

Authorizations

Body

queryobjectoptional

Responses

application/json

all ofoptional

application/json

post

HTTPcURLJavaScriptPython

POST /v2/grades/exchanges HTTP/1.1
Host: api.us2.kimonocloud.com
Content-Type: application/json
Accept: */*
Content-Length: 310

{
  "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"
            }
          }
        },
        "graded_after": "2025-04-15T03:09:55.829Z",
        "summary_type": "final"
      }
    ]
  }
}

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-04-15T03:09:55.829Z",
    "updated_at": "2025-04-15T03:09:55.829Z"
  },
  "error": {
    "status": 1,
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}

Find a Grades Exchange by id

get

Get an Exchange

Authorizations

Path parameters

idstring · uuidrequired

id of the Exchange to find

Responses

application/json

all ofoptional

get

HTTPcURLJavaScriptPython

GET /v2/grades/exchanges/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Accept: */*

{
  "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-04-15T03:09:55.829Z",
              "updated_at": "2025-04-15T03:09:55.829Z"
            }
          },
          "graded_after": "2025-04-15T03:09:55.829Z",
          "summary_type": "final"
        }
      ]
    },
    "state": "created",
    "max_data_content_length": 1,
    "error_count": 1,
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-04-15T03:09:55.829Z",
    "updated_at": "2025-04-15T03:09:55.829Z"
  },
  "error": {
    "status": 1,
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}

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

all ofoptional

get

HTTPcURLJavaScriptPython

GET /v2/grades/exchanges/{id}/errors HTTP/1.1
Host: api.us2.kimonocloud.com
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-04-15T03:09:55.829Z",
      "updated_at": "2025-04-15T03:09:55.829Z",
      "code": "query_type_not_supported",
      "message": "text",
      "details": "text"
    }
  ],
  "paging": {
    "next": "text"
  }
}

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 · enumoptionalAvailable options:

messagestringread-onlyoptional

detailsstringoptional

Responses

application/json

all ofoptional

application/json

post

HTTPcURLJavaScriptPython

POST /v2/grades/exchanges/{id}/errors HTTP/1.1
Host: api.us2.kimonocloud.com
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "code": "query_type_not_supported",
  "details": "text"
}

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-04-15T03:09:55.829Z",
    "updated_at": "2025-04-15T03:09:55.829Z",
    "code": "query_type_not_supported",
    "message": "text",
    "details": "text"
  },
  "paging": {
    "next": "text"
  }
}

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

all ofoptional

application/json

post

HTTPcURLJavaScriptPython

POST /v2/grades/exchanges/{id}/data HTTP/1.1
Host: api.us2.kimonocloud.com
Content-Type: application/json
Accept: */*
Content-Length: 2055

{
  "assignments": [
    {
      "$sys": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "source_id": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "app_id": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "created_at": "2025-04-15T03:09:55.829Z",
        "updated_at": "2025-04-15T03:09:55.829Z"
      },
      "$section": {
        "$sys": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "source_id": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "app_id": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      },
      "$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"
          }
        }
      },
      "name": "text",
      "description": "text",
      "points_possible": 1,
      "due_at": "2025-04-15T03:09:55.829Z",
      "available_at": "2025-04-15T03:09:55.829Z",
      "$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"
              }
            }
          },
          "$grader": {
            "$sys": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "source_id": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "app_id": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              }
            }
          },
          "score": 1,
          "grade": "text",
          "late": true,
          "excused": true,
          "submitted_at": "2025-04-15T03:09:55.829Z",
          "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"
          }
        }
      },
      "$person": {
        "$sys": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "source_id": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "app_id": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      },
      "$grader": {
        "$sys": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "source_id": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "app_id": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      },
      "summary_type": "midterm",
      "score_type": "raw",
      "score": 1,
      "grade": "text",
      "last_activity": "2025-04-15T03:09:55.829Z",
      "comments": [
        "text"
      ],
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "final": true
}

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-04-15T03:09:55.829Z",
    "updated_at": "2025-04-15T03:09:55.829Z"
  },
  "error": {
    "status": 1,
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}