API docs by Redocly

App BFF Service (1.0.0)

Download OpenAPI specification:

Announcements

AnnouncementsV1_list

Authorizations:
FirebaseAppCheckAuth

Responses

Response samples

Content type
application/json
{
  • "announcements": [
    ]
}

CourseRegistrations

CourseRegistrationsV1_list

履修情報を取得する

Authorizations:
(BearerAuthFirebaseAppCheckAuth)
query Parameters
year
integer

開講年度; 指定しない場合は今年度が選択される

semesters
required
Array of strings (DottoFoundationV1.CourseSemester)
Items Enum: "AllYear" "H1" "H2" "Q1" "Q2" "Q3" "Q4" "SummerIntensive" "WinterIntensive"

開講時期

Responses

Response samples

Content type
application/json
{
  • "courseRegistrations": [
    ]
}

CourseRegistrationsV1_create

履修情報を作成する

Authorizations:
(BearerAuthFirebaseAppCheckAuth)
Request Body schema: application/json
required

作成する履修情報の情報

subjectId
required
string

Responses

Request samples

Content type
application/json
{
  • "subjectId": "string"
}

Response samples

Content type
application/json
{
  • "courseRegistration": {
    }
}

CourseRegistrationsV1_delete

履修情報を削除する

Authorizations:
(BearerAuthFirebaseAppCheckAuth)
path Parameters
id
required
string

履修情報ID

Responses

PersonalCalendarItems

PersonalCalendarItemsV1_list

個人カレンダーアイテム一覧を取得する

Authorizations:
(BearerAuthFirebaseAppCheckAuth)
query Parameters
dates
required
Array of strings <date> [ items <date > ]

日付のリスト; 指定した日付の個人カレンダーアイテムのみを取得する

Responses

Response samples

Content type
application/json
{
  • "personalCalendarItems": [
    ]
}

CancelledClasses

CancelledClassesV1_list

休講一覧を取得する

Authorizations:
(BearerAuthFirebaseAppCheckAuth)
query Parameters
subjectIds
Array of strings

科目IDのリスト; 指定した科目の休講のみを取得する; 指定しない場合は全科目を検索対象とする

from
string <date>

検索対象開始日付

until
string <date>

検索対象終了日付

Responses

Response samples

Content type
application/json
{
  • "cancelledClasses": [
    ]
}

MakeupClasses

MakeupClassesV1_list

補講一覧を取得する

Authorizations:
(BearerAuthFirebaseAppCheckAuth)
query Parameters
subjectIds
Array of strings

科目IDのリスト; 指定した科目の補講のみを取得する; 指定しない場合は全科目を検索対象とする

from
string <date>

検索対象開始日付

until
string <date>

検索対象終了日付

Responses

Response samples

Content type
application/json
{
  • "makeupClasses": [
    ]
}

RoomChanges

RoomChangesV1_list

教室変更一覧を取得する

Authorizations:
(BearerAuthFirebaseAppCheckAuth)
query Parameters
subjectIds
Array of strings

科目IDのリスト; 指定した科目の教室変更のみを取得する; 指定しない場合は全科目を検索対象とする

from
string <date>

検索対象開始日付

until
string <date>

検索対象終了日付

Responses

Response samples

Content type
application/json
{
  • "roomChanges": [
    ]
}

Subjects

SubjectsV1_list

科目を検索する

同一項目同士はOR、異なる項目同士はANDでフィルタリングされます。

Authorizations:
FirebaseAppCheckAuth
query Parameters
q
string

検索ワード

grades
Array of strings (DottoFoundationV1.Grade)
Items Enum: "B1" "B2" "B3" "B4" "M1" "M2" "D1" "D2" "D3"

学年

courses
Array of strings (DottoFoundationV1.Course)
Items Enum: "InformationSystem" "InformationDesign" "AdvancedICT" "ComplexSystem" "IntelligentSystem"

コース; 大学院の場合は大学院コースに読み替え

classes
Array of strings (DottoFoundationV1.Class)
Items Enum: "A" "B" "C" "D" "E" "F" "G" "H" "I" "J" "K" "L"

クラス; 大学院の学年を選択した場合は選択できない

classifications
Array of strings (DottoFoundationV1.SubjectClassification)
Items Enum: "Specialized" "Cultural" "ResearchInstruction"

学部: 専門・教養; 大学院: 専門・研究指導

semesters
Array of strings (DottoFoundationV1.CourseSemester)
Items Enum: "AllYear" "H1" "H2" "Q1" "Q2" "Q3" "Q4" "SummerIntensive" "WinterIntensive"

開講時期

requirementTypes
Array of strings (DottoFoundationV1.SubjectRequirementType)
Items Enum: "Required" "Optional" "OptionalRequired"

必修・選択・選択必修

culturalSubjectCategories
Array of strings (DottoFoundationV1.CulturalSubjectCategory)
Items Enum: "Society" "Human" "Science" "Health" "Communication"

教養科目カテゴリ

Responses

Response samples

Content type
application/json
{
  • "subjects": [
    ]
}

SubjectsV1_detail

Authorizations:
FirebaseAppCheckAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "subject": {
    }
}

TimetableItems

TimetableItemsV1_list

時間割を取得する

Authorizations:
FirebaseAppCheckAuth
query Parameters
year
integer

開講年度; 指定しない場合は今年度が選択される

semesters
required
Array of strings (DottoFoundationV1.CourseSemester)
Items Enum: "AllYear" "H1" "H2" "Q1" "Q2" "Q3" "Q4" "SummerIntensive" "WinterIntensive"

開講時期

Responses

Response samples

Content type
application/json
{
  • "timetableItems": [
    ]
}

Users

UsersV1_detail

ユーザーを取得する

Authorizations:
(BearerAuthFirebaseAppCheckAuth)

Responses

Response samples

Content type
application/json
{
  • "user": {
    }
}

UsersV1_upsert

ユーザーを作成または更新する

Authorizations:
(BearerAuthFirebaseAppCheckAuth)
Request Body schema: application/json
required

作成または更新するユーザーの情報

grade
string (DottoFoundationV1.Grade)
Enum: "B1" "B2" "B3" "B4" "M1" "M2" "D1" "D2" "D3"

学年

course
string (DottoFoundationV1.Course)
Enum: "InformationSystem" "InformationDesign" "AdvancedICT" "ComplexSystem" "IntelligentSystem"

コース

class
string (DottoFoundationV1.Class)
Enum: "A" "B" "C" "D" "E" "F" "G" "H" "I" "J" "K" "L"

クラス

Responses

Request samples

Content type
application/json
{
  • "grade": "B1",
  • "course": "InformationSystem",
  • "class": "A"
}

Response samples

Content type
application/json
{
  • "user": {
    }
}

FCM Tokens

FCMTokenV1_upsert

FCMトークンを作成または更新する 存在しない場合は作成し、存在する場合は更新日時を更新する

Authorizations:
(BearerAuthFirebaseAppCheckAuth)
Request Body schema: application/json
required

作成または更新するFCMトークンの情報

token
required
string

Responses

Request samples

Content type
application/json
{
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "fcmToken": {
    }
}