Dashboard Unassigned Students¶

Fetch the students who are not assigned to a dashboard.

Linked From:

API Root

Student¶

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

GET¶

The GET method is used to fetch a paginated collection of a students who are not assigned to a dashboard. The students are returned ordered by id in ascending order.

The GET method supports the following query string parameters:

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.
`current`	When true, filter down to users who exist in Dropout Detective today. When false, filter down to users who do not exist in Dropout Detective today. Not setting this will return all users.
`account`	Filter down to students not on a dashboard within the given account or all of its subaccounts. If this account is not the root account, the student could be on a dashboard in another account. 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/students/unassigned/
Content-Type:: application/json

Example Success Response¶

URL:: /detective/api/v2/dashboard/students/unassigned/
Status:: 200 OK Request
Content-Type:: application/json

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