Dashboard Students
==================

Manage the students associated with a dashboard.

To change the students on dashboards, use :doc:`dashboard_uploads`

Linked From:
  * :doc:`root`


Dashboard Student
-----------------
.. list-table::
  :header-rows: 1
  :widths: 30, 70

  * - Field
    - Description
  * - ``id``
    - The ID for the user.
  * - ``name``
    - The name of the user.
  * - ``sis_id``
    - The SIS ID for the user.


.. note::

    To create dashboard students, use the
    :ref:`Dashboard Upload POST <Dashboard Upload POST>` endpoint.


GET
---

The ``GET`` method is used to fetch a paginated collection of a dashboards students.
The students are returned ordered by ``id`` in ascending order.

The ``GET`` method supports the following query string parameters:

.. list-table::
  :header-rows: 1
  :widths: 30, 70

  * - Parameter
    - Description
  * - ``cursor``
    - A unique identifier to fetch the next or previous page. It is supplied
      in the response as a way to navigate pages.
  * - ``q``
    - Filter down to users whose name contains the term.
  * - ``id``
    - Filter down to users whose ID matches this value.
  * - ``sis_id``
    - Filter down to users whose SIS ID matches this value.
  * - ``account``
    - Filter down to students on dashboards for the given account and all of its
      subaccounts. The account must be a subaccount of the account
      associated with your API token.

Accepted Request Content-Types:
  ``application/json``

Available Response Content-Types:
  ``application/json``


Example Request
~~~~~~~~~~~~~~~

URL:
  ``/detective/api/v2/dashboard/<dashboard_id>/student/``

Content-Type:
  ``application/json``


Example Success Response
~~~~~~~~~~~~~~~~~~~~~~~~

URL:
  ``/detective/api/v2/dashboard/00000000-0000-0000-0000-000000000000/student/``
Status:
  200 OK Request
Content-Type:
  ``application/json``

.. code-block:: json

    {
      "next": "https://apps.aspiredu.com/detective/api/v2/dashboard/00000000-0000-0000-0000-000000000000/student/?cursor=UNIQUE_STRING",
      "previous": "https://apps.aspiredu.com/detective/api/v2/dashboard/00000000-0000-0000-0000-000000000000/student/?cursor=DIFFERENT_UNIQUE_STRING",
      "results": [
        {
          "id": "10",
          "sis_id": "10",
          "name": "Abigail Cooper"
        },
        {
          "id": "1",
          "sis_id": "1",
          "name": "Emily Cooper"
        }
      ]
    }