Domoscio Docs

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

Each Student has a Student Cluster which contains the Students who are similar to him/her.

{{ :api2:student:student_cluster.png?400 |Student Cluster }}

===Object resources===
^ Property     ^ Type      ^ Description         ^
| id | Integer | identifier for the database of Domoscio's API |
| student_id | Integer | The Student the Student Cluster belongs to |
| 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_clusters/{student_cluster_id} |

If no student_cluster_id is provided it will fetch all the Student Clusters for your instance.

==Get the response (JSON output example)==

**With ID provided**\\

<code>
{
    "id": 385,
    "created_at": "2017-11-24T13:20:31.549Z",
    "updated_at": "2017-11-24T13:20:31.549Z",
    "student_id": 372,
    "cluster_id": 72
}
</code>


**Without ID provided**\\
<code>
[
    {
        "id": 384,
        "created_at": "2017-11-24T13:19:56.437Z",
        "updated_at": "2017-11-24T13:19:56.437Z",
        "student_id": 371,
        "cluster_id": 71
    },
    {
        "id": 385,
        "created_at": "2017-11-24T13:20:31.549Z",
        "updated_at": "2017-11-24T13:20:31.549Z",
        "student_id": 372,
        "cluster_id": 72
    }
]
</code>

Domoscio Docs

User Tools

Site Tools

Page Tools