Interop Data API

List all Orgs

GEThttps://api.us2.kimonocloud.com/v2/interop/data/rostering/orgs

Query parameters

Response

200

Orgs response

Body

application/json

dataarray of Org (all of)

pagingobject

Request

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "id": "2a4a2e06-7755-43bb-9766-4f398079ef8c",
      "name": "Kimono School District"
    }
  ],
  "paging": {
    "next": "text"
  }
}

List all LEA-type Orgs

GEThttps://api.us2.kimonocloud.com/v2/interop/data/rostering/leas

Query parameters

Response

200

Orgs response

Body

application/json

dataarray of Org (all of)

pagingobject

Request

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "id": "2a4a2e06-7755-43bb-9766-4f398079ef8c",
      "name": "Kimono School District"
    }
  ],
  "paging": {
    "next": "text"
  }
}

List all School-type Orgs

GEThttps://api.us2.kimonocloud.com/v2/interop/data/rostering/schools

Query parameters

Response

200

Orgs response

Body

application/json

dataarray of Org (all of)

pagingobject

Request

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "id": "2a4a2e06-7755-43bb-9766-4f398079ef8c",
      "name": "Kimono School District"
    }
  ],
  "paging": {
    "next": "text"
  }
}

Find an Org by $sys.id

GEThttps://api.us2.kimonocloud.com/v2/interop/data/rostering/orgs/{id}

Path parameters

id*string (uuid)

$sys.id of the object

Response

200404

Org response

Body

application/json

dataOrg (all of)

errorobject

Request

JavaScriptCurlPython

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

Response

200

{
  "data": {
    "id": "2a4a2e06-7755-43bb-9766-4f398079ef8c",
    "name": "Kimono School District"
  },
  "error": {
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}

List Students that are members of an Org

GEThttps://api.us2.kimonocloud.com/v2/interop/data/rostering/orgs/{id}/students

Path parameters

id*string (uuid)

$sys.id of the Org

Query parameters

Response

200404

Array of Persons

Body

application/json

dataarray of Person (all of)

pagingobject

Request

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "$sys": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "label": "text",
        "created_at": "2024-11-21T10:35:31.905Z",
        "updated_at": "2024-11-21T10:35:31.905Z",
        "person_type": "text"
      },
      "local_id": "text",
      "state_id": "text",
      "name": {
        "last": "text",
        "first": "text",
        "middle": "text"
      },
      "address": {
        "line1": "text",
        "line2": "text",
        "line3": "text",
        "city": "text",
        "state": "text",
        "postal_code": "text",
        "country": "text"
      },
      "phone": "text",
      "email": "[e-mail]",
      "sex": "text",
      "dob": "2024-11-21",
      "aup": false,
      "grad_year": "text",
      "$schools": [
        {
          "$sys": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "label": "text",
            "org_type": "text"
          }
        }
      ],
      "$sections": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "label": "text"
        }
      ]
    }
  ],
  "paging": {
    "next": "text"
  }
}

List Teachers that are members of an Org

GEThttps://api.us2.kimonocloud.com/v2/interop/data/rostering/orgs/{id}/teachers

Path parameters

id*string (uuid)

$sys.id of the Org

Query parameters

Response

200

Array of Persons

Body

application/json

dataarray of Person (all of)

pagingobject

Request

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "$sys": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "label": "text",
        "created_at": "2024-11-21T10:35:31.905Z",
        "updated_at": "2024-11-21T10:35:31.905Z",
        "person_type": "text"
      },
      "local_id": "text",
      "state_id": "text",
      "name": {
        "last": "text",
        "first": "text",
        "middle": "text"
      },
      "address": {
        "line1": "text",
        "line2": "text",
        "line3": "text",
        "city": "text",
        "state": "text",
        "postal_code": "text",
        "country": "text"
      },
      "phone": "text",
      "email": "[e-mail]",
      "sex": "text",
      "dob": "2024-11-21",
      "aup": false,
      "grad_year": "text",
      "$schools": [
        {
          "$sys": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "label": "text",
            "org_type": "text"
          }
        }
      ],
      "$sections": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "label": "text"
        }
      ]
    }
  ],
  "paging": {
    "next": "text"
  }
}

List Courses that belong to an Org

GEThttps://api.us2.kimonocloud.com/v2/interop/data/rostering/orgs/{id}/courses

Path parameters

id*string (uuid)

$sys.id of the Org

Query parameters

Response

200

Array of Orgs

Body

application/json

dataarray of Course (all of)

pagingobject

Request

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "$sys": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "label": "text",
        "created_at": "2024-11-21T10:35:31.905Z",
        "updated_at": "2024-11-21T10:35:31.905Z"
      },
      "local_id": "text",
      "title": "text",
      "description": "text",
      "$orgs": [],
      "$sections": [
        {
          "$sys": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "label": "text"
          }
        }
      ]
    }
  ],
  "paging": {
    "next": "text"
  }
}

List Sections that belong to an Org

GEThttps://api.us2.kimonocloud.com/v2/interop/data/rostering/orgs/{id}/sections

Path parameters

id*string (uuid)

$sys.id of the Org

Query parameters

Response

200

Array of Sections

Body

application/json

dataarray of Section (all of)

pagingobject

Request

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "local_id": "text",
      "title": "text",
      "description": "text",
      "$terms": [
        {
          "$sys": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "label": "text",
            "term_type": "text"
          }
        }
      ],
      "$course": {
        "$sys": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "label": "text"
        }
      },
      "$teachers": [],
      "$students": []
    }
  ],
  "paging": {
    "next": "text"
  }
}

List Terms that belong to an Org

GEThttps://api.us2.kimonocloud.com/v2/interop/data/rostering/orgs/{id}/terms

Path parameters

id*string (uuid)

$sys.id of the Org

Query parameters

Response

200

Terms response

Body

application/json

dataarray of Term (all of)

pagingobject

Request

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "$sys": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "label": "text",
        "created_at": "2024-11-21T10:35:31.905Z",
        "updated_at": "2024-11-21T10:35:31.905Z",
        "term_type": "text"
      },
      "name": "text",
      "description": "text",
      "start_date": "2024-11-21",
      "end_date": "2024-11-21",
      "status": "text",
      "$children": []
    }
  ],
  "paging": {
    "next": "text"
  }
}

Find an LEA-type Org by $sys.id

GEThttps://api.us2.kimonocloud.com/v2/interop/data/rostering/leas/{id}

Path parameters

id*string (uuid)

$sys.id of the LEA

Response

200

Org response

Body

application/json

$extobject

$sysall of

local_idstring

namestring

$parentobject

$childrenarray

$studentsarray of object

$teachersarray

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "2a4a2e06-7755-43bb-9766-4f398079ef8c",
  "name": "Kimono School District"
}

Get all Persons

GEThttps://api.us2.kimonocloud.com/v2/interop/data/rostering/persons

Query parameters

Response

200

Array of Person

Body

application/json

dataarray of Person (all of)

pagingobject

Request

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "$sys": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "label": "text",
        "created_at": "2024-11-21T10:35:31.905Z",
        "updated_at": "2024-11-21T10:35:31.905Z",
        "person_type": "text"
      },
      "local_id": "text",
      "state_id": "text",
      "name": {
        "last": "text",
        "first": "text",
        "middle": "text"
      },
      "address": {
        "line1": "text",
        "line2": "text",
        "line3": "text",
        "city": "text",
        "state": "text",
        "postal_code": "text",
        "country": "text"
      },
      "phone": "text",
      "email": "[e-mail]",
      "sex": "text",
      "dob": "2024-11-21",
      "aup": false,
      "grad_year": "text",
      "$schools": [
        {
          "$sys": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "label": "text",
            "org_type": "text"
          }
        }
      ],
      "$sections": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "label": "text"
        }
      ]
    }
  ],
  "paging": {
    "next": "text"
  }
}

List all Student-type Persons

GEThttps://api.us2.kimonocloud.com/v2/interop/data/rostering/students

Query parameters

Response

200

Array of Person

Body

application/json

dataarray of Person (all of)

pagingobject

Request

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "$sys": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "label": "text",
        "created_at": "2024-11-21T10:35:31.905Z",
        "updated_at": "2024-11-21T10:35:31.905Z",
        "person_type": "text"
      },
      "local_id": "text",
      "state_id": "text",
      "name": {
        "last": "text",
        "first": "text",
        "middle": "text"
      },
      "address": {
        "line1": "text",
        "line2": "text",
        "line3": "text",
        "city": "text",
        "state": "text",
        "postal_code": "text",
        "country": "text"
      },
      "phone": "text",
      "email": "[e-mail]",
      "sex": "text",
      "dob": "2024-11-21",
      "aup": false,
      "grad_year": "text",
      "$schools": [
        {
          "$sys": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "label": "text",
            "org_type": "text"
          }
        }
      ],
      "$sections": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "label": "text"
        }
      ]
    }
  ],
  "paging": {
    "next": "text"
  }
}

List all Teacher-type Persons

GEThttps://api.us2.kimonocloud.com/v2/interop/data/rostering/teachers

Query parameters

Response

200

Array of Person

Body

application/json

dataarray of Person (all of)

pagingobject

Request

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "$sys": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "label": "text",
        "created_at": "2024-11-21T10:35:31.905Z",
        "updated_at": "2024-11-21T10:35:31.905Z",
        "person_type": "text"
      },
      "local_id": "text",
      "state_id": "text",
      "name": {
        "last": "text",
        "first": "text",
        "middle": "text"
      },
      "address": {
        "line1": "text",
        "line2": "text",
        "line3": "text",
        "city": "text",
        "state": "text",
        "postal_code": "text",
        "country": "text"
      },
      "phone": "text",
      "email": "[e-mail]",
      "sex": "text",
      "dob": "2024-11-21",
      "aup": false,
      "grad_year": "text",
      "$schools": [
        {
          "$sys": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "label": "text",
            "org_type": "text"
          }
        }
      ],
      "$sections": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "label": "text"
        }
      ]
    }
  ],
  "paging": {
    "next": "text"
  }
}

Find a Person by $sys.id

GEThttps://api.us2.kimonocloud.com/v2/interop/data/rostering/persons/{id}

Path parameters

id*string (uuid)

$sys.id of the Person to find

Response

200

Person response

Body

application/json

$extobject

$sys*all of

local_idstring

state_idstring

nameNameType (object)

addressAddressType (object)

phonestring

emailstring (email)

sexstring

dobstring (date)

aupboolean

grad_yearstring

$schoolsarray of object

$sectionsarray of all of

Request

JavaScriptCurlPython

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

Response

200

{
  "$sys": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "label": "text",
    "created_at": "2024-11-21T10:35:31.905Z",
    "updated_at": "2024-11-21T10:35:31.905Z",
    "person_type": "text"
  },
  "local_id": "text",
  "state_id": "text",
  "name": {
    "last": "text",
    "first": "text",
    "middle": "text"
  },
  "address": {
    "line1": "text",
    "line2": "text",
    "line3": "text",
    "city": "text",
    "state": "text",
    "postal_code": "text",
    "country": "text"
  },
  "phone": "text",
  "email": "[e-mail]",
  "sex": "text",
  "dob": "2024-11-21",
  "aup": false,
  "grad_year": "text",
  "$schools": [
    {
      "$sys": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "text",
        "label": "text",
        "org_type": "text"
      }
    }
  ],
  "$sections": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "label": "text"
    }
  ]
}

List all Courses

GEThttps://api.us2.kimonocloud.com/v2/interop/data/rostering/courses

Query parameters

Response

200

Array of Course

Body

application/json

dataarray of Course (all of)

pagingobject

Request

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "$sys": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "label": "text",
        "created_at": "2024-11-21T10:35:31.905Z",
        "updated_at": "2024-11-21T10:35:31.905Z"
      },
      "local_id": "text",
      "title": "text",
      "description": "text",
      "$orgs": [],
      "$sections": [
        {
          "$sys": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "label": "text"
          }
        }
      ]
    }
  ],
  "paging": {
    "next": "text"
  }
}

Find a Course by $sys.id

GEThttps://api.us2.kimonocloud.com/v2/interop/data/rostering/courses/{id}

Path parameters

id*string (uuid)

$sys.id of the Course to find

Response

200

Course response

Body

application/json

$extobject

$sysobject

local_idstring

titlestring

descriptionstring

$orgsarray

$sectionsarray of object

Request

JavaScriptCurlPython

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

Response

200

{
  "$sys": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "label": "text",
    "created_at": "2024-11-21T10:35:31.905Z",
    "updated_at": "2024-11-21T10:35:31.905Z"
  },
  "local_id": "text",
  "title": "text",
  "description": "text",
  "$orgs": [],
  "$sections": [
    {
      "$sys": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "text",
        "label": "text"
      }
    }
  ]
}

List all Sections

GEThttps://api.us2.kimonocloud.com/v2/interop/data/rostering/sections

Query parameters

Response

200

Array of Section

Body

application/json

dataarray of Section (all of)

pagingobject

Request

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "local_id": "text",
      "title": "text",
      "description": "text",
      "$terms": [
        {
          "$sys": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "label": "text",
            "term_type": "text"
          }
        }
      ],
      "$course": {
        "$sys": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "label": "text"
        }
      },
      "$teachers": [],
      "$students": []
    }
  ],
  "paging": {
    "next": "text"
  }
}

Find a Section by $sys.id

GEThttps://api.us2.kimonocloud.com/v2/interop/data/rostering/sections/{id}

Path parameters

id*string (uuid)

$sys.id of the Section to find

Response

200

Section response

Body

application/json

$extobject

local_idstring

titlestring

descriptionstring

$termsarray of object

$courseobject

$teachersarray

$studentsarray

Request

JavaScriptCurlPython

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

Response

200

{
  "local_id": "text",
  "title": "text",
  "description": "text",
  "$terms": [
    {
      "$sys": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "text",
        "label": "text",
        "term_type": "text"
      }
    }
  ],
  "$course": {
    "$sys": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "label": "text"
    }
  },
  "$teachers": [],
  "$students": []
}

List all Terms

GEThttps://api.us2.kimonocloud.com/v2/interop/data/rostering/terms

Query parameters

Response

200

Array of Terms

Body

application/json

dataarray of Term (all of)

pagingobject

Request

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "$sys": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "label": "text",
        "created_at": "2024-11-21T10:35:31.905Z",
        "updated_at": "2024-11-21T10:35:31.905Z",
        "term_type": "text"
      },
      "name": "text",
      "description": "text",
      "start_date": "2024-11-21",
      "end_date": "2024-11-21",
      "status": "text",
      "$children": []
    }
  ],
  "paging": {
    "next": "text"
  }
}

Find a Term by $sys.id

GEThttps://api.us2.kimonocloud.com/v2/interop/data/rostering/terms/{id}

Path parameters

id*string (uuid)

$sys.id of the Term to find

Response

200

Term response

Body

application/json

$extobject

$sysall of

namestring

descriptionstring

start_datestring (date)

end_datestring (date)

statusstring

$childrenarray

Request

JavaScriptCurlPython

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

Response

200

{
  "$sys": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "label": "text",
    "created_at": "2024-11-21T10:35:31.905Z",
    "updated_at": "2024-11-21T10:35:31.905Z",
    "term_type": "text"
  },
  "name": "text",
  "description": "text",
  "start_date": "2024-11-21",
  "end_date": "2024-11-21",
  "status": "text",
  "$children": []
}

List all Grading Categories

GEThttps://api.us2.kimonocloud.com/v2/interop/data/grades/gradingCategories

Query parameters

Response

200

GradingCategory response

Body

application/json

dataarray of GradingCategory (all of)

pagingobject

Request

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "name": "text"
    }
  ],
  "paging": {
    "next": "text"
  }
}