Registration Groups

A registration group object represents the registration groups in which students are arranged in a school.

Access: This is a read-only resource managed directly by the school.

Permissions: a school level access token with the school scope is required to access registration group information. To access the students in registration groups, the students scopes is also required. To access the supervisors for registration groups, the staff_members scope is also required.

List Registration Groups

Returns a list of registration groups that match the given set of filters. Registration groups are returned in name order.

Note the If-Modified-Since header is optional (see the page on Conditional Requests for more details).

Request

GET /registration_groups
Headers
Accept: application/vnd.assembly+json; version=1
Authorization: Bearer b2s7a9s8BQokikJOvBiI2HlWgH4olfQ2
If-Modified-Since: Mon, 13 Mar 2017 20:00:00 GMT
Parameter Default Example Description
year_code 7

only include groups that contain students in this year

per_page 100 25

number of results to return

page 1 2

page number to return

URI Template: /registration_groups

Response 200

Headers
Content-Type: application/json; charset=utf-8
Last-Modified: Mon, 13 Mar 2017 20:00:00 GMT
Payload
{
    "object": "list",
    "total_count": 20,
    "total_pages": 1,
    "current_page": 1,
    "prev_page": null,
    "next_page": null,
    "data": [
        {
            "object": "registration_group",
            "id": 1,
            "name": "10A",
            "supervisor_ids": [
                1
            ],
            "student_ids": [
                15,
                50,
                109
            ]
        }
    ]
}

View a Registration Group

Returns a single registration group whose code matches the provided group_id. Additionally includes a list of all the student identifiers that are present in the group.

Request

GET /registration_groups/{group_id}
Headers
Accept: application/vnd.assembly+json; version=1
Authorization: Bearer b2s7a9s8BQokikJOvBiI2HlWgH4olfQ2
Parameter Default Example Description
group_id 1

ID of the Registration Group as an Integer

URI Template: /registration_groups/{group_id}

Response 200

Headers
Content-Type: application/json; charset=utf-8
Payload
{
    "object": "registration_group",
    "code": 1,
    "name": "10A",
    "supervisor_ids": [
        1
    ],
    "student_ids": [
        15,
        50,
        109
    ]
}

List Students for Registration Group

Returns a list of all the students that are present in the registration group identified by group_id.

Note the If-Modified-Since header is optional (see the page on Conditional Requests for more details).

Request

GET /registration_groups/{group_id}/students
Headers
Accept: application/vnd.assembly+json; version=1
Authorization: Bearer b2s7a9s8BQokikJOvBiI2HlWgH4olfQ2
If-Modified-Since: Mon, 13 Mar 2017 20:00:00 GMT
Parameter Default Example Description
group_code 1

ID of the Registration Group as an Integer

year_code 7

only include students from this year

demographics false true

include demographics data

care false true

include 'in care' info

per_page 100 25

number of results to return

page 1 2

page number to return

URI Template: /registration_groups/{group_id}/students

Response 200

Headers
Content-Type: application/json; charset=utf-8
Last-Modified: Mon, 13 Mar 2017 20:00:00 GMT
Payload
{
   "object":"list",
   "total_count":2,
   "total_pages":1,
   "current_page":1,
   "prev_page":null,
   "next_page":null,
   "data":[
      {
         "object":"student",
         "id":15,
         "upn":"J823432114002",
         "first_name":"George",
         "middle_name":"Nathaniel",
         "last_name":"Adams",
         "dob":"2003-12-01"
      },
      {
         "object":"student",
         "id":50,
         "upn":"L820200107039",
         "first_name":"Tiger",
         "middle_name":null,
         "last_name":"Anton",
         "dob":"2004-02-09"
      }
   ]
}