Student: list registrations and grades

​

Lists all registrations belonging to a profile, optionally narrowed by registration state (registration_states) and/or academic context (context_ids). Each registration is returned with the unit's grade columns and any grade values that have been recorded. Pass include=courses to embed a course object describing the unit on each entry.

Path Parameters
  • profile_id
    Type: string
    required

    Unique identifier of the profile.

Query Parameters
  • registration_states
    Type: string

    Comma-separated list of registration states to filter by. Allowed values are conditional, registered, rejected. Omit to return registrations in any state. Returns 400 if any value is outside the allowed set.

  • context_ids
    Type: string

    Comma-separated list of academic context identifiers to scope the result to. Each entry can be a unit's course ID (matching registrations on that course's transcript) or a class-of ID (matching registrations on that class's study plan transcript). Returns 400 if any identifier matches neither.

  • include
    Type: string

    Comma-separated list of related resources to embed in each registration. Currently only courses is supported, which adds a course object describing the unit on each entry.

Responses
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/apis/registrations/profiles/{profile_id}/registrations
curl 'https://ff-business-school.fullfabric.cloud/apis/registrations/profiles/507f1f77bcf86cd799439011/registrations?registration_states=registered%2Cconditional&context_ids=6385baad976a7719120008ca%2C6385bcf1976a77191200ba5d&include=courses' \
  --header 'FF-Auth: YOUR_SECRET_TOKEN'

[
  {
    "id": "65e6e5aaf398a642a7022ab5",
    "unit_id": "6385baad976a7719120008e3",
    "course_id": "6385bcf1976a77191200ba5d",
    "transcript_subject_id": "6385bcf1976a77191200ba5d",
    "profile_id": "6385bdd4976a7719120108e9",
    "registration_state": "registered",
    "state_name": "pass",
    "grade_state_name": "pass",
    "awarded": true,
    "published": true,
    "grade_notes": "",
    "grade_feedback": "",
    "grades": [
      {
        "id": "667ae7cb6ab728271421708e",
        "label": "Coursework",
        "name": "__coursework",
        "value": "78",
        "published": true,
        "comment": null,
        "resit_value": null,
        "resit_justification": null
      },
      {
        "id": "6385baad976a7719120008e6",
        "label": "Final grade",
        "name": "final",
        "value": "80",
        "published": true,
        "comment": null,
        "resit_value": null,
        "resit_justification": null
      }
    ],
    "created_at": 1709630890,
    "updated_at": 1712000000
  },
  {
    "id": "65e6e5aaf398a642a7022ab6",
    "unit_id": "6385baa7976a7719120005dc",
    "course_id": "6385bcf1976a77191200ba5d",
    "transcript_subject_id": "6385bcf1976a77191200ba5d",
    "profile_id": "6385bdd4976a7719120108e9",
    "registration_state": "conditional",
    "state_name": null,
    "grade_state_name": null,
    "awarded": false,
    "published": false,
    "grade_notes": "",
    "grade_feedback": "",
    "grades": [
      {
        "id": "6385baa7976a7719120005df",
        "label": "Final grade",
        "name": "final",
        "value": null,
        "published": false,
        "comment": null,
        "resit_value": null,
        "resit_justification": null
      }
    ],
    "created_at": 1709630895,
    "updated_at": 1709630895
  }
]

Successful response.