Skip to content
This repository was archived by the owner on Feb 7, 2026. It is now read-only.

API v2.1 Reference

Vlad Slepukhin edited this page Aug 24, 2014 · 3 revisions

General

Now all the requests can be called directly from /. So, the address is api.ssutt.org:8080.

Version 1 is here. and still supported

This version is current.


[GET] /2/departments

Get list of department tags and names, sorted by names.

Status code:

  • 200 - Success
  • 209 - Database Error
  • 404 - Production server is down

Response in case of success:

[
	{ 
		"tag": "bf",
		"name": "Биологический факультет",
	},
  ...
  	{
		"tag": "ff"
		"name": "Физический факультет",
    },
  ...
]

[GET] /2/department/< department_tag >/msg

Get the department message by its tag. Status code:

  • 200 - Success
  • 209 - Database Error
  • 309 - No such department
  • 404 - Production server is down

Response in case of success:

{
	"msg" : "Crucial information!"	
}
  ...

[GET] /2/department/< department_tag >/groups?filled=<1|0>

####filled = 1

Get list of all groups which have timetables for selected department.

####filled = 0

Get list of all available group names for selected department.

String group names now are supported

Status code:

  • 200 - Success
  • 209 - Database Error
  • 309 - No such department
  • 399 - No such group. Only appears due to internal errors
  • 404 - Production server is down

Response in case of success:

[
	"111",
	"112",
	...
]

[GET] /2/department/< department_tag >/group/< group_name >

Get timetable of group from department. Results are sorted by days, then by sequence of lessons, subgroup names (lexigraphically).

It has this structure:

  • 1st: array of lessons
  • 2nd: array of subjects on a day, time, sorted by parity.
  • 3rd: array of subgroups for subject

Days are numbered as for now from 0 - Monday to 5 - Saturday. Parities are:

  • 0 - numerator
  • 1 - denominator
  • 2 - full (both)

Status code:

  • 200 - Success
  • 209 - Database Error
  • 309 - No such department
  • 399 - No such group
  • 509 - Unsupported Encoding. Appears when passed non-escaped or incorrectly escaped group names
  • 404 - Production server is down

Response in case of success:

 [
 {
    "day": 0,
    "sequence": 4,
    "subject": [
      {
        "name": "англ.яз.станд.",
        "activity": "practice",
        "parity": 2,
        "subgroups": [
          {
            "subgroup": "анг.ст.7",
            "teacher": "Обликова Мария Ивановна",
            "location": "12корпус ауд.225В"
          },
          {
            "subgroup": "анг.ст.8",
            "teacher": "Кожевникова Елена Владимировна",
            "location": "12корпус ауд.229"
          },
          {
            "subgroup": "анг.ст.9",
            "teacher": "Карпец Елена Витальевна",
            "location": "12корпус ауд.313"
          },
          {
            "subgroup": "англ.ст.10",
            "teacher": "Павлова Ольга Вячеславовна",
            "location": "12корпус ауд.302"
          }
        ]
      },
      {
        "name": "переводчики",
        "activity": "practice",
        "parity": 2,
        "subgroups": [
          {
            "subgroup": "перев,3под",
            "teacher": "Шилова Светлана Алексеевна",
            "location": "12корпус ауд.125"
          }
        ]
      }
    ]
  },
  ...
  ]

With two lessons on the same day and sequence:

[...,
{
    "day": 2,
    "sequence": 2,
    "subject": [
      {
        "name": "Информатика и программирование",
        "activity": "lecture",
        "parity": 0,
        "subgroups": [
          {
            "subgroup": "",
            "teacher": "Иванова Анна Сергеевна",
            "location": "12корпус ауд.303"
          }
        ]
      },
       {
        "name": "Информатика и программирование",
        "activity": "practice",
        "parity": 1,
        "subgroups": [
          {
            "subgroup": "",
            "teacher": "Иванова Анна Сергеевна",
            "location": "12корпус ауд.303"
          }
        ]
      }
    ]
  },
  ...
  ]

Response in case of failure

TT Platform has the unified response in case of some error occurs:

Response in case of failure:

{ "errmsg": <Some Error Information > }