Staff Members

A staff_member object represents a single staff member within a school.

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

Permissions: a school level access token with the staff_members.basic scope is required to access basic staff member information. For a full list of available staff member fields and required scopes, please see our data model.

List Staff Members

Returns a list of staff members for the school accociated with the provided access_token.

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

Request

GET /staff_members
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
teachers_only false true

return only staff who are teachers

demographics false true

return demographic information along with a staff member (requires staff_members.demographics scope)

qualifications false true

include HLTA status, QT status, QT route and previous degree information (requires staff_members.qualifications scope)

per_page 100 25

number of results to return

page 1 2

page number to return

URI Template: /staff_members{?teachers_only,demographics,qualifications,per_page,page}

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": 1,
    "total_pages": 1,
    "current_page": 1,
    "prev_page": null,
    "next_page": null,
    "data": [
        {
            "object": "staff_member",
            "id": 21,
            "mis_id": "3232",
            "staff_code": "AAB",
            "first_name": "Anita",
            "legal_first_name": "Anita",
            "middle_name": null,
            "last_name": "Abell",
            "legal_last_name": "Abell",
            "former_last_name": "Abell",
            "title": "Mrs",
            "dob": "1970-11-12",
            "email": "Abell@example.com",
            "is_teaching_staff": true,
            "included_in_census": true,
            "start_date": "2011-09-01T00:00:00.000Z",
            "end_date": "2079-06-06T23:59:00.000Z"
        }
    ]
}

List Left Staff Members

Returns a list of staff members who have left the school.

Note: This will include any staff members who have left the school. If the school has been connected to Assembly for more than one academic year, all left staff members will be returned. The If-Modified-Since header is optional (see the page on Conditional Requests for more details).

Request

GET /staff_members/left
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
teachers_only false true

return only staff who are teachers

demographics false true

return demographic information along with a staff member (requires staff_members.demographics scope)

qualifications false true

include HLTA status, QT status, QT route and previous degree information (requires staff_members.qualifications scope)

per_page 100 25

number of results to return

page 1 2

page number to return

URI Template: /staff_members/left{?per_page,page}

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": 1,
    "total_pages": 1,
    "current_page": 1,
    "prev_page": null,
    "next_page": null,
    "data": [
        {
            "object": "staff_member",
            "id": 4,
            "mis_id": "1111",
            "staff_code": "BAA",
            "first_name": "Ben",
            "legal_first_name": "Benjamin",
            "middle_name": null,
            "last_name": "Andrews",
            "legal_last_name": "Andrews",
            "former_last_name": "Andrews",
            "title": "Mr",
            "dob": "1980-04-11",
            "email": "b.andrews@example.com",
            "is_teaching_staff": true,
            "included_in_census": true,
            "start_date": "2011-09-01T00:00:00.000Z",
            "end_date": "2018-06-06T23:59:00.000Z"
        }
    ]
}

View a Staff Member

Returns an individual staff member record for the given ID.

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

Request

GET /staff_members/{staff_member_id}
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
staff_member_id 1

ID of the Staff Member as an Integer

demographics false true

return demographic information along with a staff member (requires staff_members.demographics scope)

qualifications false true

include HLTA status, QT status, QT route and previous degree information (requires staff_members.qualifications scope)

URI Template: /staff_members/{staff_member_id}{?demographics,qualifications}

Response 200

Headers
Content-Type: application/json; charset=utf-8
Last-Modified: Mon, 13 Mar 2017 20:00:00 GMT
Payload
{
    "object": "staff_member",
    "id": 21,
    "mis_id": "3232",
    "staff_code": "AAB",
    "first_name": "Anita",
    "legal_first_name": "Anita",
    "middle_name": null,
    "last_name": "Abell",
    "legal_last_name": "Abell",
    "former_last_name": "Abell",
    "title": "Mrs",
    "dob": "1970-11-12",
    "email": "Abell@example.com",
    "is_teaching_staff": true,
    "included_in_census": true,
    "start_date": "2011-09-01T00:00:00.000Z",
    "end_date": "2079-06-06T23:59:00.000Z",
    "demographics": {
        "ethnicity_code": "WWEU",
        "ethnicity_group": "White",
        "gender": "F",
        "disability": "No"
    },
    "qualification_info": {
        "teacher_number": "32123121",
        "qt_status": true,
        "hlta_status": false,
        "qts_route": "School Direct (Salaried)",
        "qualifications": [
            {
                "id": 2332,
                "qualification_code": "Other First Degree or equivalent",
                "degree_class": "Upper second class honours",
                "first_subject_code": "D900",
                "first_subject_name": "Chemistry",
                "second_subject_code": null,
                "second_subject_name": null
            }
        ]
    }
}

List Staff Absences

Returns a list of staff member absences for the school accociated with the provided access_token. A school level access token with the staff_members.absences scope is required to access staff member absence information.

Request

GET /staff_absences
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
staff_member_id 1

show only absences fot the specified staff member

start_date start of academic year 2017-09-21

the start date of the period to return staff absences for

end_date end of academic year 2017-09-30

the end date of the period to return staff absences for

URI Template: /staff_absences{?staff_member_id,start_date,end_date}

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": 1,
    "total_pages": 1,
    "current_page": 1,
    "prev_page": null,
    "next_page": null,
    "data": [
        {
            "object": "staff_absence",
            "id": 2848,
            "staff_member_id": 77660,
            "start_date": "2017-09-06T14:00:00.000Z",
            "end_date": "2017-09-06T16:27:00.000Z",
            "working_days_lost": "0.500",
            "absence_category": "OTH",
            "illness_category": null,
            "pay_rate": "Pay (according to absence rules)"
        }
    ]
}

List Staff Contracts

Returns a list of staff member contracts for the school accociated with the provided access_token. A school level access token with the staff_members.contracts scope is required to access staff member contract information.

Request

GET /staff_contracts
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
staff_member_id 1

show only contracts fot the specified staff member

date today 2017-09-21

show only contracts that are current for the specified date

roles false true

return roles information along with a staff contract

salaries false true

return salaries information along with a staff contract (requires staff_members.salaries scope for full information - only the hours_per_week, fte and weeks_per_year fields are shown without it)

allowances false true

return allowances information along with a staff contract (requires staff_members.salaries scope)

URI Template: /staff_contracts{?staff_member_id,date,roles,salaries,allowances}

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": 1,
    "total_pages": 1,
    "current_page": 1,
    "prev_page": null,
    "next_page": null,
    "data": [
        {
            "object": "staff_contract",
            "id": 2848,
            "staff_member_id": 77660,
            "start_date": "2015-09-06T14:00:00.000Z",
            "end_date":null,
            "national_insurance_number": "FG800343T",
            "payroll_number": "3356781",
            "contract_type": "Fixed Term",
            "post": "Advisory Teacher",
            "origin": "Other education post in England or Wales",
            "destination": "Deceased",
            "daily_rate": true,
            "pay_review_date": "2017-11-02T00:00:00.000Z",
            "roles": [
                {
                    "object": "staff_role",
                    "role_type": "Classroom Teacher",
                    "start_date": "2016-05-21T00:00:00.000Z",
                    "end_date": null
                }
            ],
            "salaries": [
                {
                    "object": "staff_salary",
                    "hours_per_week": "36.0",
                    "fte": "1.0",
                    "weeks_per_year": "52.0",
                    "pay_range": "Leadership",
                    "start_date": "2016-04-27T00:00:00.000Z",
                    "end_date": null,
                    "pay_scale_framework": "N51",
                    "regional_spine": "London Fringe",
                    "base_pay": "38400.0",
                    "actual_pay": "38400.0",
                    "safeguarded_salary": true
                }
            ],
            "allowances": [
                {
                    "object": "staff_allowance",
                    "additional_payment_type": "Teaching and Learning Responsibility Payments",
                    "additional_payment_amount": "3100.0",
                    "start_date": "2017-07-15T00:00:00.000Z",
                    "end_date": null
                }
            ]
        }
    ]
}