API-Documentation

Rooms API

GET /api/v1/room/{roomName}/schedule/{date}

Get schedules of the room specified for the week of the specified date, starting from Monday.

Parameters:

• roomName (string) – Room name to fetch schedule for

• date (string) – Date to fetch schedule for

Example request:

GET /api/v1/room/{roomName}/schedule/{date} HTTP/1.1
Host: example.com

Status Codes:

• 200 OK –

  OK

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  [
      {
          "location": "RO",
          "room": "string",
          "name": "string",
          "lecturer": "string",
          "relevantDegrees": "string",
          "startTime": "2026-03-04T00:26:05.086399",
          "endTime": "2026-03-04T00:26:05.086399"
      }
  ]
  

GET /api/v1/room/{roomName}/schedule/related

Get schedules in the area of the room specified and all rooms available in the cache.

Parameters:

• roomName (string) – Room name to use as base for related schedules

Example request:

GET /api/v1/room/{roomName}/schedule/related HTTP/1.1
Host: example.com

Status Codes:

• 200 OK –

  OK

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  {}
  

GET /api/v1/room/{roomName}/schedule

Get schedules of the room specified for the current week, starting from Monday.

Parameters:

• roomName (string) – Room name to fetch schedule for

Example request:

GET /api/v1/room/{roomName}/schedule HTTP/1.1
Host: example.com

Status Codes:

• 200 OK –

  OK

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  [
      {
          "location": "RO",
          "room": "string",
          "name": "string",
          "lecturer": "string",
          "relevantDegrees": "string",
          "startTime": "2026-03-04T00:26:05.086399",
          "endTime": "2026-03-04T00:26:05.086399"
      }
  ]
  

GET /api/v1/room/{roomName}

Get location of the specified room.

Parameters:

• roomName (string) – Room name to fetch location

Example request:

GET /api/v1/room/{roomName} HTTP/1.1
Host: example.com

Status Codes:

• 200 OK –

  OK

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  {
      "name": "string",
      "location": {
          "lat": 1.0,
          "lng": 1.0
      }
  }
  

• 404 Not Found – No room found with the specified name.

GET /api/v1/room/extended

Fetch all rooms stored in the database associated with their building name, e.g. A0.10 -> A building, Room A0.10.

Example request:

GET /api/v1/room/extended HTTP/1.1
Host: example.com

Status Codes:

• 200 OK –

  OK

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  [
      {
          "name": "string",
          "location": {
              "lat": 1.0,
              "lng": 1.0
          },
          "buildingName": "string"
      }
  ]
  

GET /api/v1/room/

Fetch all rooms stored in the database.

Example request:

GET /api/v1/room/ HTTP/1.1
Host: example.com

Status Codes:

• 200 OK –

  OK

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  [
      {
          "name": "string",
          "location": {
              "lat": 1.0,
              "lng": 1.0
          }
      }
  ]
  

Admin API

DELETE /api/v1/admin/schedules

Clear all cached schedules

Status Codes:

• 200 OK – OK

DELETE /api/v1/admin/room

Delete all rooms from the database

Status Codes:

• 200 OK – OK

DELETE /api/v1/admin/room/{roomName}

Delete a room from the database

Parameters:

• roomName (string) – Room name to delete

Status Codes:

• 200 OK – OK