This objects indicates that a particular student belongs to a particular cluster.

Object resources

Property Type Description
id Integer identifier for the database of Domoscio's API
student_id Integer The related student
student_cluster_id Integer The related cluster
matching Float Float between 0 and 1 which indicates the proximity between the related Student and the Student who “owns” the Cluster
created_at DateTime Date of creation of the object
updated_at DateTime Last time the object has been modified

Fetch (GET)

Method GET
URL /student_cluster_memberships/{student_cluster_memberships_id}

If no student_cluster_membership_id is provided, it will fetch all Student Cluster Membership of your instance. You can choose to filter by adding the parameters student_cluster_id or student_id.

Get the response (JSON output example)

With Id provided

{
    "id": 951,
    "student_id": 375,
    "matching": 0.8,
    "student_cluster_id": 385,
    "created_at": "2017-11-24T17:22:02.570Z",
    "updated_at": "2017-11-24T17:22:02.570Z"
}

Without Id provided

[
    {
        "id": 951,
        "student_id": 375,
        "matching": 0.8,
        "student_cluster_id": 385,
        "created_at": "2017-11-24T17:22:02.570Z",
        "updated_at": "2017-11-24T17:22:02.570Z"
    },
    {
        "id": 952,
        "student_id": 378,
        "matching": 0.9,
        "student_cluster_id": 385,
        "created_at": "2017-11-24T17:22:10.367Z",
        "updated_at": "2017-11-24T17:22:10.367Z"
    }
]