Meetings
:: services/meetings module

Retrieve Institution meetings

Methods

accept_participant Accept participant to specific meeting date
cart Get user meetings cart
course_meetings Search for specific course meetings for student
courses_with_meetings Search for student course units with meetings
delete_note Delete private or public note.
generate_meeting_dates Generate meeting dates
get_meeting_substantiations Get meeting substantiations
get_note Get meeting note.
get_rejection_substantiations Get meeting rejection substantiations
lecturer Search for meetings for lecturer
lecturer_meeting_dates Search for meeting dates of specified meeting conducted by user.
meeting Get information about a single meeting.
meeting_all_dates Search for all meeting dates for specific meeting.
meeting_date Get information about single meeting date
meeting_date_participants Get meeting date participants.
meeting_dates Get information about multiple meeting dates
meetings Get information about a multiple meetings.
note Get meeting note instance.
open_meeting_dates Search for open meeting dates for specific lecturer
participant Get information about meeting participant.
participants Get information about multiple meeting participants.
put_note Create or edit meeting note
reject_participant Reject participant from specific meeting date
search_meeting_dates Search for dates fot specific meeting for student
sign_off Sign off from specific meeting date
sign_up Sign up for specific meeting date
sign_up_non_usos_person Sign up non USOS person for specific meeting date
sign_up_specific_user Sign up specific user for specific meeting date
substantiation Get substantiation object
user_calendar Search lecturer's meeting dates

services/meetings/accept_participant

Consumer: required Token: required Scopes: none SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.

Accept participant to specific meeting date

participant_id required Participant ID
message_lang_code optional

Default value: pl

Language code for message about changing the order in the list

Possible values: pl, en.

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 dict on success.

Thrown errors:

  • meeting_subscription_exception - Error regarding meeting subscription.

    Possible reasons:

    • user_already_accepted - User has been already accepted to this meeting date.

services/meetings/cart

Consumer: required Token: required Scopes: none SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.

Get user meetings cart

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 participant 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:

List of meeting participant entries, as described in participant.

services/meetings/course_meetings

Consumer: required Token: required Scopes: none SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.

Search for specific course meetings for student

course_id required Course ID
fields optional

Default value: id|name|comment|open

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of meeting 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:

List of course meetings, as described in meeting.

Thrown errors:

  • object_invalid - object is in invalid state.

    Possible reasons:

    • not_in_course - user is not registered to specified course.

services/meetings/courses_with_meetings

Consumer: required Token: required Scopes: none SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.

Search for student course units with meetings

fields optional

Default value: id

Selector of result fields you are interested in. The selector must contain subset of primary fields, which are described in the returns section of services/courses/unit 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:

List of course units with meetings, as descibed in services/courses/unit.

services/meetings/delete_note

Consumer: required Token: required Scopes: none SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.
Delete private or public note. Only staff members or administrative consumers can access this method.
note_id required Note ID
note_type required Note type

Possible values: private, public.

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 dict on success.

Thrown errors:

  • method_forbidden - access to method denied.

    Possible reasons:

    • staff_only - this method can only be invoked by staff members.

services/meetings/generate_meeting_dates

Consumer: required Token: required Scopes: none SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.

Generate meeting dates using timetable activities generation algorithm.

Note that this method does not create any meeting entries.

start_date required Start date
end_date required End date
number required Number of meeting dates
frequency required Type of frequency

Possible values: daily, weekly, week_days, weekends, biweekly_odd, biweekly_even, monthly.

use_calendar optional

Default value: false

Boolean, should calendar be used
week_day optional

Default value: (empty string)

Number of week day (if needed by frequency)
fac_id optional

Default value: (empty string)

Faculty ID
start_even optional

Default value: false

Start from even week
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:

List of dates.

services/meetings/get_meeting_substantiations

Consumer: required Token: optional Scopes: n/a SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.
Get meeting substantiations for organization unit
fac_id required faculty ID
with_parents optional

Default value: true

boolean, should parent faculties be also selected?
fields optional

Default value: id|name|message|type

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of substantiation 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 optional oauth_token for Token authorization.

Returned value:

List of meeting substantiations, as described in substantiation.

services/meetings/get_note

Consumer: required Token: required Scopes: none SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.

Get meeting note.

fac_id required Faculty ID
term_id required Term ID
user_id required User ID
note_type required type of note

Possible values: private, public.

fields optional

Default value: id|creation_date|content

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 note;

  • creation_date - datetime of creation;

  • content - Note content.

Thrown errors:

  • method_forbidden - access to method denied.

    Possible reasons:

    • staff_only - this method can only be invoked by staff members.

services/meetings/get_rejection_substantiations

Consumer: required Token: optional Scopes: n/a SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.
Get meeting rejection substantiations for organization unit
fac_id required faculty ID
with_parents optional

Default value: true

boolean, should parent faculties be also selected?
fields optional

Default value: id|name|message|type

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of substantiation 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 optional oauth_token for Token authorization.

Returned value:

List of meeting substantiations, as described in substantiation.

services/meetings/lecturer

Consumer: required Token: required Scopes: none SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.
Get all meetings available for lecturer
fields optional

Default value: id|name|comment|open

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of meeting 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:

List of lecturer meetings, as described in meeting.

Thrown errors:

  • object_invalid - object is in invalid state.

    Possible reasons:

    • not_a_staff - user is not a staff member.

services/meetings/lecturer_meeting_dates

Consumer: required Token: required Scopes: none SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.
Search for meeting dates of specified meeting conducted by user. Only staff members or administrative consumers can access this method.
meeting_id required Meeting ID
fields optional

Default value: id|comment|start_time|end_time|registration_start_time|registration_end_time|seats_limit|reserve_seats_limit|meeting

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of meeting_date 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:

List of dates for meeting, as described in meeting_date.

Thrown errors:

  • method_forbidden - access to method denied.

    Possible reasons:

    • staff_only - this method can only be invoked by staff members.

services/meetings/meeting

Consumer: required Token: required Scopes: none SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.

Get information about a single meeting.

meeting_id required Meeting ID
fields optional

Default value: id|name|comment|open

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 meeting;

  • name - LangDict, meeting name;

  • comment - LangDict, meeting comment;

  • faculty - meeting faculty.

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

  • term - term assigned to meeting or null if no term was assigned.

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

  • lecturer - Lecturer.

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

  • open - boolean, is meeting open?;

  • can_i_attend - boolean, can I attend?.

    User can attend the meeting if the meeting is open or they are a participant of one of the groups assigned to meeting
  • state - meeting state.

    Possible values:

    • active

    • in_preparation

    • closed

    • archived

  • substantiation_mode - substantiation choice mode.

    Possible values:

    • this_faculty_only - user can use only justifications from faculty of the meeting

    • this_faculty_and_parents - user can use justifications from faculty of the meeting and parents

  • auto_accept - boolean, are requests accepted automatically?;

  • groups - groups assigned to meeting.

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

  • soonest_datetime - datetime, start of soonest meeting date (see meeting_date) or null if this meeting does not have any future dates.

services/meetings/meeting_all_dates

Consumer: required Token: required Scopes: none SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.

Search for all meeting dates for specific meeting.

meeting_id required Meeting ID
fields optional

Default value: id|comment|start_time|end_time|registration_start_time|registration_end_time|seats_limit|reserve_seats_limit|meeting

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of meeting_date 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:

List of all meeting dates for meeting, as defined in meeting_date method.

services/meetings/meeting_date

Consumer: required Token: required Scopes: none SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.

Get information about single meeting date

meeting_date_id required ID of meeting date
fields optional

Default value: id|comment|start_time|end_time|registration_start_time|registration_end_time|seats_limit|reserve_seats_limit|meeting

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;

  • comment - LangDict, meeting date comment;

  • start_time - datetime, start time;

  • end_time - datetime, end time;

  • registration_start_time - datetime, registration start time;

  • registration_end_time - datetime, registration end time;

  • seats_limit - seats limit;

  • reserve_seats_limit - seserve seats limit;

  • meeting - meeting.

    This field references objects returned by meeting method. See its returns section for possible subfields.

  • registered_participants_count - number of registered participants;

  • accepted_participants_count - number of participants in the main list;

  • waiting_participants_count - number of participants in the reserve list;

  • user_status - registration status of user.

    Possible values:

    • accepted - user is accepted to meeting

    • waiting - user is waiting for acceptance

    • rejected - user has been rejected

    • token_created - registration token has been generated

    • null - user has not registered to meeting

  • can_i_sign_up - boolean, can I sign up for meeting?;

  • can_i_sign_out - boolean, can I sign out from meeting?;

  • room - room assigned to meeting date or null if no room was assigned.

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

services/meetings/meeting_date_participants

Consumer: required Token: required Scopes: none SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.
Get meeting date participants. Only staff members or administrative consumers can access this method.
meeting_date_id required Meeting date ID
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 participant 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:

List of meeting date participants, as descibed in participant.

Thrown errors:

  • method_forbidden - access to method denied.

    Possible reasons:

    • staff_only - this method can only be invoked by staff members.

services/meetings/meeting_dates

Consumer: required Token: required Scopes: none SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.

Get information about multiple meeting dates

meeting_date_ids required ID of meeting date
fields optional

Default value: id|comment|start_time|end_time|registration_start_time|registration_end_time|seats_limit|reserve_seats_limit|meeting

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of meeting_date 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 that will map your meeting_date_ids to meeting date objects, as defined in the meeting_date method.

services/meetings/meetings

Consumer: required Token: required Scopes: none SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.

Get information about a multiple meetings.

meeting_ids required Meeting IDs
fields optional

Default value: id|name|comment|open

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of meeting 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 that will map your meeting_ids to meeting objects, as defined in the meeting method or null if meeting with such ID does not exist.

services/meetings/note

Consumer: required Token: required Scopes: none SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.
Get meeting note instance, that is both public and private meeting note. This method is meant for staff, because it only returns notes authored by access token issuer.
id required Meeting note ID
fields optional

Default value: id|creation_date|private_note|public_note

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;

  • faculty - faculty associated with note or null if no faculty is associated.

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

  • term - term assigned to note or null if no term was assigned.

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

  • user - user regarding the note.

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

  • creation_date - datetime of creation;

  • private_note - string, private note;

  • public_note - string, public note.

Thrown errors:

  • method_forbidden - access to method denied.

    Possible reasons:

    • staff_only - this method can only be invoked by staff members.

services/meetings/open_meeting_dates

Consumer: required Token: required Scopes: none SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.

Search for open meeting dates for specific lecturer

lecturer_id required Lecturer ID
fields optional

Default value: id|comment|start_time|end_time|registration_start_time|registration_end_time|seats_limit|reserve_seats_limit|meeting

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of meeting_date 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:

List of open meeting dates for lecturer, as defined in meeting_date method.

Thrown errors:

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

services/meetings/participant

Consumer: required Token: required Scopes: none SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.
Get information about meeting participant.
participant_id required Participant ID
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 - Participant ID;

  • is_external - boolean, is participant from outside of university?.

    Participant is defined as from outside of university if they were registered with name and email instead of USOS user record. See also sign_up_non_usos_person.
  • user - user participant or null if participant is external (as defined in is_external field).

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

  • meeting_date - meeting date for this participant entry.

    This field references objects returned by meeting_date method. See its returns section for possible subfields.

  • external_first_name - first name of externally registered participant or null if participant is not external;

  • external_last_name - first name of externally registered participant or null if participant is not external;

  • external_email - email address of externally registered participant or null if participant is not external or email was not provided;

  • external_contact - extra contact data of externally registered participant or null if participant is not external or extra contact data was not provided;

  • status - registration status.

    Possible values:

    • accepted - user is accepted to meeting

    • waiting - user is waiting for acceptance

    • rejected - user has been rejected

    • token_created - registration token has been generated

  • is_reserve - boolean, is user on reserve list?;

  • lecturer_actions - allowed actions for lecturer;

  • user_actions - allowed actions for user;

  • public_notes - list of note instances which have a public note for participant.

    This field references objects returned by note method. See its returns section for possible subfields.

  • private_notes - list of note instances which have a private note for participant.

    Note that this field can be only accessed by meeting lecturer. Otherwise it will always return empty list.

    This field references objects returned by note method. See its returns section for possible subfields.

  • substantiation - substantiation for meeting or null if no substantiation was provided.

    This field references objects returned by substantiation method. See its returns section for possible subfields.

  • rejection_substantiation - substantiation for rejection or null if no substantiation was provided.

    This field references objects returned by substantiation method. See its returns section for possible subfields.

  • substantiation_message - custom substantiation message or null if it was not provided;

  • rejection_substantiation_message - custom substantiation rejection message or null if it was not provided;

  • number_in_queue - integer, position of user in meeting queue or null if user is rejected.

services/meetings/participants

Consumer: required Token: required Scopes: none SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.

Get information about multiple meeting participants.

participant_ids required Pipe-separated list of participant 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 participant 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 that will map your participant_ids to participant objects, as defined in the participant method.

services/meetings/put_note

Consumer: required Token: required Scopes: none SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.

Create or edit meeting note

fac_id required Faculty ID
term_id required Term ID
user_id required User ID
note_type required type of note

Possible values: private, public.

content required Note content
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 dict on success.

Thrown errors:

  • method_forbidden - access to method denied.

    Possible reasons:

    • staff_only - this method can only be invoked by staff members.

services/meetings/reject_participant

Consumer: required Token: required Scopes: none SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.

Reject participant from specific meeting date

participant_id required Participant ID
substantiation_id optional Rejection substantiation ID
substantiation_message optional Rejection substantiation message
message_lang_code optional

Default value: pl

Language code for message about changing the order in the list

Possible values: pl, en.

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 dict on success.

Thrown errors:

  • meeting_subscription_exception - Error regarding meeting subscription.

    Possible reasons:

    • invalid_substantiation - selected substantiation cannot be used;

    • user_already_rejected - User has been already rejected from this meeting date;

    • user_is_not_staff - User is not staff.

services/meetings/search_meeting_dates

Consumer: required Token: required Scopes: none SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.
Get dates for specific meeting for student
meeting_id required Meeting ID
fields optional

Default value: id|comment|start_time|end_time|registration_start_time|registration_end_time|seats_limit|reserve_seats_limit|meeting

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of meeting_date 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:

List of meeting dates for specific meeting, as described in meeting_date

services/meetings/sign_off

Consumer: required Token: required Scopes: none SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.

Sign off from specific meeting date

meeting_date_id required Meeting date ID
message_lang_code optional

Default value: pl

Language code for message about changing the order in the list

Possible values: pl, en.

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 dict on success.

Thrown errors:

  • meeting_subscription_exception - Error regarding meeting subscription.

    Possible reasons:

    • meeting_date_has_started - Meeting date has already started;

    • user_not_registered - User is not registered to meeting.

services/meetings/sign_up

Consumer: required Token: required Scopes: none SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.

Sign up for specific meeting date

meeting_date_id required Meeting date ID
substantiation_id required Substantiation ID
substantiation_message optional Substantiation message
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 dict on success.

Thrown errors:

  • meeting_subscription_exception - Error regarding meeting subscription.

    Possible reasons:

    • invalid_substantiation - selected substantiation cannot be used;

    • meeting_date_ended - Meeting date registration has already ended;

    • meeting_date_not_begun - Meeting date registration has not yet begun;

    • meeting_not_active - Meeting is not active;

    • no_user_permissions - User does not have permission to this meeting;

    • seats_limit_exceeded - There is no seats in this group;

    • user_already_subscribed - User has already subscribed to this meeting date.

services/meetings/sign_up_non_usos_person

Consumer: required Token: required Scopes: none SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.

Sign up non USOS person for specific meeting date

meeting_date_id required Meeting date ID
first_name required First name
last_name required Last name
status optional

Default value: accepted

user registration status

Possible values: accepted, waiting.

email optional E-mail address
contact_data optional Contact data
substantiation_id optional Substantiation ID
substantiation_message optional Substantiation message
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 dict on success.

Thrown errors:

  • meeting_subscription_exception - Error regarding meeting subscription.

    Possible reasons:

    • invalid_substantiation - selected substantiation cannot be used;

    • non_usos_person_email_subscribed - Non USOS person has already subscribed.

services/meetings/sign_up_specific_user

Consumer: required Token: required Scopes: none SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.

Sign up specific user for specific meeting date

user_id required User ID
meeting_date_id required Meeting date ID
status optional

Default value: accepted

user registration status

Possible values: accepted, waiting.

substantiation_id optional Substantiation ID
substantiation_message optional Substantiation message
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 dict on success.

Thrown errors:

  • meeting_subscription_exception - Error regarding meeting subscription.

    Possible reasons:

    • invalid_substantiation - selected substantiation cannot be used.

services/meetings/substantiation

Consumer: required Token: optional Scopes: n/a SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.

Get substantiation object

id required ID of substantiation
fields optional

Default value: id|name|message|type

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 optional oauth_token for Token authorization.

Returned value:

A dictionary of selected fields and their values.

Available fields:

  • id - id;

  • name - LangDict, name of substantiation;

  • message - LangDict, message for user;

  • type - type of substantiation.

    Possible values:

    • meeting - this is substantiation for meeting acceptance

    • rejection - this is substantiation for rejection of meeting

  • faculty - An associated faculty.

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

services/meetings/user_calendar

Consumer: required Token: required Scopes: none SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.

Search lecturer's meeting dates

lecturer_id required Lecturer ID
start optional

Default value: (empty string)

Start date, today if empty
days optional

Default value: 7

Days count
fields optional

Default value: id|comment|start_time|end_time|registration_start_time|registration_end_time|seats_limit|reserve_seats_limit|meeting

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of meeting_date 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:

List of meeting date objects, as described in meeting_date
USOS API ver. 6.1.2.0-3, 7f29f74c, dirty (2020-10-21)