Aflabs APIs

In order to use Aflabs APIs you need to set afLabsApiSharedSecret in System Configuration. This secret is used to authenticate requests to Aflabs APIs. You pass it as the secret query parameter.

If afLabsApiSharedSecret is not set (empty), all Aflabs endpoints will return an error indicating the feature is disabled.

Get All Group Registrations

Returns group registrations for all students that have an enrolment number set.

Request

GET https://TODO_FLOW_HOST/thirdParty/aflabs/groupRegistrations?secret={{afLabsApiSharedSecret}}

Query parameters

parameter	type	description
secret	String	Required. The shared secret configured in afLabsApiSharedSecret
semesterId	String?	Optional. If provided, filters to a specific semester. Otherwise, all active semesters are used

Response

field	type	description
internalId	String	Enrolment number of the student
groupRegistrations	object[]	List of group registrations for the student
groupRegistrations.subject	String	Course short name (derived from the course number)
groupRegistrations.type	String	Execution type short name (e.g. VL, P, ...)
groupRegistrations.group	String	Name of the group

info

Only students with an enrolment number and at least one group registration in the requested semesters are included in the response.

Example:

[
  {
    "internalId": "12345678",
    "groupRegistrations": [
      {
        "subject": "MAT1",
        "type": "VL",
        "group": "Group A"
      },
      {
        "subject": "PHY1",
        "type": "P",
        "group": "Group B"
      }
    ]
  }
]

Get Group Registration

Returns group registrations for a single student identified by their enrolment number.

Request

GET https://TODO_FLOW_HOST/thirdParty/aflabs/groupRegistration?secret={{afLabsApiSharedSecret}}&internalId={{internalId}}

Query parameters

parameter	type	description
secret	String	Required. The shared secret configured in afLabsApiSharedSecret
internalId	String	Required. The enrolment number of the student
semesterId	String?	Optional. If provided, filters to a specific semester. Otherwise, all active semesters are used

Response

Returns a single student object, or null if no student with the given enrolment number exists.

field	type	description
internalId	String	Enrolment number (Matrikelnumber) of the student
groupRegistrations	object[]	List of group registrations for the student
groupRegistrations.subject	String	Course short name (derived from the course number)
groupRegistrations.type	String	Execution type short name (e.g. VL, P, ...)
groupRegistrations.group	String	Name of the group

Example:

{
  "internalId": "12345678",
  "groupRegistrations": [
    {
      "subject": "MAT1",
      "type": "VL",
      "group": "Group A"
    }
  ]
}