Ctrl+K

FS course#

A group for students and instructors in a particular course / subject.

Availability#

Attribute group

To retrieve these groups, the application needs access to the groups-edu attribute group / scope.

Organization type

This group type is available for higher education, where the organization has enabled the integration with Felles Studentsystem (FS).

Member list

Example#

{
  "id": "fc:fs:fs:emne:example.org:OTF5913:A",
  "type": "fc:fs:emne",
  "displayName": "Bruk av oddetall",
  "membership": {
    "basic": "member",
    "active": true,
    "displayName": "Student",
    "fsroles": [
      "STUDENT"
    ],
    "notBefore": "2024-07-30T22:00:00Z",
    "notAfter": "2025-07-30T22:00:00Z",
    "subjectRelations": "undervisning"
  },
  "url": "https://www.example.org/emne/otf5913",
  "parent": "fc:org:example.org"
}

Group object#

The group objects has the following fields:

id (required, string)

Unique identifier of the group. This is a string with the format fc:fs:fs:emne:<realm>:<course-id>:<course-version>. <realm> is the domain name of the organization. <course-id> is the code for the course. <course-version> identifies a particular version of the course.

type (required, string)

The group type. Always the string fc:fs:emne for courses.

displayName (required, string)

The name of the course.

membership (optional, object)

The role of the current user in the group. This field is only present when requesting groups for a specific user.

url (optional, string)

An URL to a description of the course.

parent (required, string)

The id of the parent group. This is the organization group.

Membership objects#

The membership object describes the role of the user in the course.

{
  "basic": "member",
  "active": true,
  "displayName": "Student",
  "fsroles": [
    "STUDENT"
  ],
  "notBefore": "2024-07-30T22:00:00Z",
  "notAfter": "2025-07-30T22:00:00Z",
  "subjectRelations": "undervisning"
}

It has the following fields:

basic (required, string)

The basic membership role of the user. This field is a string with one of the following values:

  • owner: For instructors, etc in the course.

  • member: For students in the course.

active (required, boolean)

Whether the user is currently active in the group.

displayName (required, string)

A human readable descriptive name of the affiliation to the group.

fsroles (required, list of strings)

A list of roles from Felles studentsystem. E.g. ["STUDENT"].

notBefore (optional, string)

The date/time when the membership started.

notAfter (optional, string)

The date/time when the membership ended.

subjectRelations (required, string)

The relation of the user to the course. One or both of the following values:

  • undervisning

  • vurdering

(If both values are present, they are separated by a comma.)

On this page