Introduction
- Authorization
- Libraries and Examples
- Working with API
- Method Reference
  - adm_documents Info on administration documents
  - apiref Accessing API docs
  - apisrv API server data
  - apistlog Method call stats
  - attendance Attendance lists
  - blobbox Storing binary data
  - calendar University calendar
  - cards Data on users' ID cards
  - courses Info on courses
  - credits Study credits info
  - crstests Course tests
  - csgroups User-defined groups
  - eforms Submiting, monitoring and accepting form and requests
    - calendars Editing eform calendars
    - comments Interface for managing user comments.
    - logs Monitoring changes of forms and requests for admins
    - modules Modules
    - operations Allows to execute some bulk operations on selected eforms for admins
    - opinions Setting visibility of opinion of eform for admins
    - processes Administrative interface for managing processes flows. Typical CRUD.
    - renderer Based on the Mustache markup (library chevron) rendering engine for eform applications
    - reports Module rsponsible for generating and executing mass operations and reports
    - roles Submiting, monitoring and accepting form and requests
    - statuses Administrative interface for managing statuses. Typical CRUD.
    - tasks Managing daemon and tasks
    - templates Administering templates of opinions, decisions and emails
    - types Administering eform types.
    - userroles Administering user roles in eforms module
  - emrex Student mobility
  - events Event subscriptions
  - events2 Manage events and notifiactions preferences
  - examrep Exam reports info
  - examrep2 Exam reports info
  - exams Registration for exams
  - fac Information on faculties
  - facperms Per-faculty permissions
  - feedback Feedback reports
  - fileshare Sharing files
  - geo Geographical data
  - grades Accessing grades info
  - groups Accessing group info
  - guide University guide
  - housing Dormitories and housing
  - instaddr Institutional addresses
  - mailclient Composing emails
  - mailing Sending email messages
  - meetings University meetings
  - mobility Access and edit Learning Agreement
  - news Faculty and university news
  - oauth OAuth Authorization
  - oauth2 OAuth provider module
  - payments Students' payments module
  - phones Phone numbers
  - photos User-photo settings
  - pit Access to PIT declarations
  - plctests Placement tests
  - prgroups Primary groups
  - progs Study programmes
  - pw_ankieta Dostęp do metod i danych PW - ogólnouczelnianych
  - pw_asystent Dostęp do metod i danych PW - ogólnouczelnianych
  - pw_cregs Accessing PW decisions
  - pw_decisions Access USOS data - PW decisions
  - pw_fica Dostęp do metod i danych PW - ogólnouczelnianych
  - pw_jednostka Dostęp do metod i danych PW - ogólnouczelnianych
  - pw_pensum Moduł Pensum PW
  - pw_statements Signing PW statements
  - pw_student Dostęp do metod i danych PW - ogólnouczelnianych
  - pw_suplements Accepting suplements
  - registrations University registrations
  - slips Clearance slips
  - statements Signing statements
  - surveys Satisfaction surveys
  - terms Info on Academic Terms
  - theses Theses and diplomas
  - tt Accessing activity timetables
  - uprefs User preferences
  - users Accessing user information
- Contact us

Libraries and Examples

Libraries

There are no official SDKs or libraries - we believe that basic understanding of HTTP protocol is enough to efficiently use our services.

However, there are some unofficial libraries you might want to use. Many of those are currently maintained by members of the USOS Team, but we do not guarantee that all of these projects will stay alive:

jQuery-USOS — a set of jQuery plugins and widgets for web developers. It is being used in some of the projects of USOS. Not updated since 2019.
usosapi-python — simple Python 3 module for desktop applications. It may help with the authorization process.
usos4j — a simple Java-based module for server and desktop apps.
usos-rs — Rust bindings for USOS API authentication.

If you know of any other possibly useful libraries (i.e. you've written one), let us know!

Examples

Some sample USOS API applications for you to download:

Hello World, written in PHP - source code on GitHub | screenshot

A simple web application. When authorized, it retrieves user's name and some other details. It requires OAuth PHP extension to run.
USOS API Browser, written in C# (.NET, WPF) - source code on GitHub | screenshot | install

Windows desktop application. It allows you to browse through USOS API methods (thanks to the apiref module) and execute them with arguments you supply.
Simple Proxy, written in PHP - source code on GitHub

An USOS API proxy. It signs all requests that it receives (with a hardcoded Consumer Key), executes a given USOS API method and returns the result. Might be used in a closed, secure environment, in order to allow other applications to access USOS API methods with a simple HTTP request. It requires OAuth PHP extension to run.
Today's schedule, written in Python - source code | screenshot

Simple console application. Displays today's activities (tt module). Required Python 2.6 to run (one of many Python OAuth libraries is already included).

USOS API ver. 7.1.0.0-4, b58e51a8, dirty (2024-09-03)