Accessing attendance lists
:: services/attendance module

These API methods allow you to create and fill attendance lists.

Methods

add_attendance_date BETA Add new meeting date to attendance list.
attendance BETA Get information of attendance.
attendance_list BETA Get information of a single attendance list.
attendance_lists BETA Get information of multiple attendance lists.
create_attendance_list BETA Create a new attendance list.
group BETA Get information of attendance lists for selected group.
update_attendance BETA Update attendance entry.

services/attendance/add_attendance_date

Consumer: required Token: required Scopes: staff_perspective SSL: required
https://usosapi.tu.koszalin.pl/services/attendance/add_attendance_date

This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can.

Add new meeting date to attendance list.

list_id required ID of attendance list
date required Datetime of meeting, in datetime format
format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization.

Returned value:

Empty dictionary on success.

Thrown errors:

  • object_invalid - object is in invalid state.

    Possible reasons:

    • no_students - the group does not have any participants.

  • object_not_found - some of the referenced objects do not exist.

    Possible reasons:

    • attendance_list_not_found - attendance list does not exist.

services/attendance/attendance

Consumer: required Token: required Scopes: staff_perspective SSL: required
https://usosapi.tu.koszalin.pl/services/attendance/attendance

This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can.

Get information of attendance.

list_id required ID of attendance list
date optional Datetime of meeting, in datetime format
student_ids optional Pipe-separated list of student IDs
fields optional

Default value: student|date|attendance_mode

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section.

format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization.

Returned value:

A list of entries for specified attendance list. Each entry will be a dictionary of selected fields and their values.

Notes:

  • By default, if there is any entry for some date, the method will return entries for all students in the class group, but the ones without explicit attendance information were absent (i.e. absence will be passed).

  • The method does not rely on timetable information for group, which means that the entries for specified date will be provided only if at least one entry for this date was created (via e.g. update_attendance).

  • If student_ids was set, then the list will be filtered to specified students.

  • If date was set, then the list will only have entries for specified date.

Available fields:

  • student - student who the entry concerns.

    This field references objects returned by services/users/user method. See its returns section for possible subfields.

  • date - date of meeting, in datetime format;

  • attendance_mode - mode of attendance in the meeting.

    Possible values:

    • intramural - the person was in faculty building

    • remote - the person paticipated in meeting remotely

    • justified_absence - the person was not present at the meeting, but justified their absence

    • absence - the person was not present at the meeting

  • comment - comment or null if no comment was provided.

Thrown errors:

  • object_not_found - some of the referenced objects do not exist.

    Possible reasons:

    • attendance_list_not_found - attendance list does not exist.

services/attendance/attendance_list

Consumer: required Token: required Scopes: staff_perspective SSL: required
https://usosapi.tu.koszalin.pl/services/attendance/attendance_list

This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can.

Get information of a single attendance list.

list_id required ID of attendance list
fields optional

Default value: id

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section.

format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization.

Returned value:

A dictionary of selected fields and their values.

Available fields:

  • id - ID of the attendance list;

  • course_unit - Course unit.

    This field references objects returned by services/courses/course_unit method. See its returns section for possible subfields (only primary are allowed).

  • group_number - Group number;

  • owner - Owner of the attendance list.

    This field references objects returned by services/users/user method. See its returns section for possible subfields.

  • mode - mode of meetings of the class group.

    Possible values:

    • intramural - the meetings are conducted in faculty building

    • remote - the meetings are conducted remotely

    • hybrid - mix of the first two options, some students can be in faculty building, while others can attend remotely

Thrown errors:

  • object_not_found - some of the referenced objects do not exist.

    Possible reasons:

    • attendance_list_not_found - attendance list does not exist.

services/attendance/attendance_lists

Consumer: required Token: required Scopes: staff_perspective SSL: required
https://usosapi.tu.koszalin.pl/services/attendance/attendance_lists

This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can.

Get information of multiple attendance lists.

list_ids required Pipe-separated list of attendance list IDs.
fields optional

Default value: id

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of attendance_list method.

format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization.

Returned value:

A dictionary: your list_ids will be mapped to dictionary's keys, and each value will contain the description of one attendance list, as defined in the attendance_list method.

For invalid list_ids (attendance lists which do not exist) null will be returned (instead of the attendance list object).

services/attendance/create_attendance_list

Consumer: required Token: required Scopes: staff_perspective SSL: required
https://usosapi.tu.koszalin.pl/services/attendance/create_attendance_list

This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can.

Create a new attendance list.

course_unit_id required ID of course unit
group_number required Group number
mode required Mode of meetings in the classgroup, as described in attendance_list

Possible values: hybrid, intramural, remote.

format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization.

Returned value:

A dictionary of the following structure:

  • list_id - ID of created attendance list.

Thrown errors:

  • object_invalid - object is in invalid state.

    Possible reasons:

    • no_students - the group does not have any participants.

  • object_not_found - some of the referenced objects do not exist.

    Possible reasons:

    • group_not_found - specified course group does not exist or user is not its lecturer.

services/attendance/group

Consumer: required Token: required Scopes: staff_perspective SSL: required
https://usosapi.tu.koszalin.pl/services/attendance/group

This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can.

Get information of attendance lists for selected group.

course_unit_id required ID of course unit
group_number required Group number
fields optional

Default value: id

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of attendance_list method.

format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization.

Returned value:

A list of attendance list objects, as defined in the attendance_list method.

services/attendance/update_attendance

Consumer: required Token: required Scopes: staff_perspective SSL: required
https://usosapi.tu.koszalin.pl/services/attendance/update_attendance

This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can.

Update attendance entry.

list_id required ID of attendance list
date required Datetime of meeting, in datetime format
student_id required ID of student
attendance_mode optional

Default value: absence

Mode of attendance in the meeting.

Possible values: justified_absence, intramural, absence, remote.

comment optional Comment
format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization.

Returned value:

Empty dictionary on success.

Thrown errors:

  • object_invalid - object is in invalid state.

    Possible reasons:

    • intramural_attendance_not_allowed - intramural attendance is not allowed in this attendance list;

    • remote_attendance_not_allowed - remote attendance is not allowed in this attendance list;

    • student_not_in_group - student is not in group for specified attendance list.

  • object_not_found - some of the referenced objects do not exist.

    Possible reasons:

    • attendance_list_not_found - attendance list does not exist.

USOS API ver. 6.6.0.0-15a, c56039d0, dirty (2021-02-08)