API docs by Redocly

Admin BFF Service (1.0.0)

Download OpenAPI specification:

Announcements

AnnouncementsV1_list

Authorizations:
BearerAuth

Responses

Response samples

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

AnnouncementsV1_create

おしらせを作成する

Authorizations:
BearerAuth
Request Body schema: application/json
required

作成するおしらせの情報

title
required
string
availableFrom
required
string <date-time>
availableUntil
string <date-time>
url
required
string <uri>

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "availableFrom": "2019-08-24T14:15:22Z",
  • "availableUntil": "2019-08-24T14:15:22Z",
  • "url": "http://example.com"
}

Response samples

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

AnnouncementsV1_detail

おしらせを詳細取得する

Authorizations:
BearerAuth
path Parameters
id
required
string

おしらせID

Responses

Response samples

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

AnnouncementsV1_update

おしらせを更新する

Authorizations:
BearerAuth
path Parameters
id
required
string

おしらせID

Request Body schema: application/json
required

更新するおしらせの情報

title
required
string
availableFrom
required
string <date-time>
availableUntil
string <date-time>
url
required
string <uri>

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "availableFrom": "2019-08-24T14:15:22Z",
  • "availableUntil": "2019-08-24T14:15:22Z",
  • "url": "http://example.com"
}

Response samples

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

AnnouncementsV1_delete

おしらせを削除する

Authorizations:
BearerAuth
path Parameters
id
required
string

おしらせID

Responses

CourseRegistrations

CourseRegistrationsV1_list

履修情報を取得する

Authorizations:
BearerAuth
query Parameters
userId
required
string

ユーザーID

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
{
  • "registrations": [
    ]
}

CourseRegistrationsV1_create

履修情報を作成する

Authorizations:
BearerAuth
Request Body schema: application/json
required

作成する履修情報の情報

userId
required
string
subjectId
required
string

Responses

Request samples

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

Response samples

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

CourseRegistrationsV1_delete

履修情報を削除する

Authorizations:
BearerAuth
path Parameters
id
required
string

履修情報ID

Responses

Faculties

FacultiesV1_list

教員一覧を取得する

Authorizations:
BearerAuth
query Parameters
q
string

検索ワード; 教員の名前で部分一致検索される

Responses

Response samples

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

FacultiesV1_create

教員を作成する

Authorizations:
BearerAuth
Request Body schema: application/json
required

作成する教員の情報

name
required
string
email
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "string"
}

Response samples

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

FacultiesV1_detail

教員を詳細取得する

Authorizations:
BearerAuth
path Parameters
id
required
string

教員ID

Responses

Response samples

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

FacultiesV1_update

教員を更新する

Authorizations:
BearerAuth
path Parameters
id
required
string

教員ID

Request Body schema: application/json
required

更新する教員の情報

name
required
string
email
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "string"
}

Response samples

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

FacultiesV1_delete

教員を削除する

Authorizations:
BearerAuth
path Parameters
id
required
string

教員ID

Responses

PersonalCalendarItems

PersonalCalendarItemsV1_list

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

Authorizations:
BearerAuth
query Parameters
userId
required
string

ユーザーID

dates
required
Array of strings <date> [ items <date > ]

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

Responses

Response samples

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

CancelledClasses

CancelledClassesV1_list

休講一覧を取得する

Authorizations:
BearerAuth
query Parameters
subjectIds
Array of strings

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

from
string <date>

検索対象開始日付

until
string <date>

検索対象終了日付

Responses

Response samples

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

CancelledClassesV1_create

休講を作成する

Authorizations:
BearerAuth
Request Body schema: application/json
required

作成する休講の情報

subjectId
required
string
date
required
string <date>
period
required
string (DottoFoundationV1.Period)
Enum: "Period1" "Period2" "Period3" "Period4" "Period5" "Period6"
comment
required
string

Responses

Request samples

Content type
application/json
{
  • "subjectId": "string",
  • "date": "2019-08-24",
  • "period": "Period1",
  • "comment": "string"
}

Response samples

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

CancelledClassesV1_fetch

教務システムから休講を取得する

Authorizations:
BearerAuth

Responses

Response samples

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

CancelledClassesV1_delete

休講を削除する

Authorizations:
BearerAuth
path Parameters
id
required
string

休講ID

Responses

Notifications

NotificationV1_list

通知の一覧を取得する

Authorizations:
BearerAuth
query Parameters
notifyAtFrom
string <date-time>

通知予定日時の開始日時 (notifyAt >= notifyAtFrom)

notifyAtTo
string <date-time>

通知予定日時の終了日時 (notifyAt <= notifyAtTo)

isNotified
boolean

通知済みかどうか (true: 通知済みの通知のみ、false: 通知未済みの通知のみ、指定なし: 全ての通知)

Responses

Response samples

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

NotificationV1_create

通知を作成する 存在しない場合は作成し、存在する場合は更新日時を更新する

Authorizations:
BearerAuth
Request Body schema: application/json
required

作成する通知の情報

title
required
string
message
required
string
url
string
notifyAt
required
string <date-time>
targetUserIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "message": "string",
  • "url": "string",
  • "notifyAt": "2019-08-24T14:15:22Z",
  • "targetUserIds": [
    ]
}

Response samples

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

NotificationV1_update

通知を更新する

Authorizations:
BearerAuth
path Parameters
id
required
string

通知ID

Request Body schema: application/json
required

更新する通知の情報

title
required
string
message
required
string
url
string
notifyAt
required
string <date-time>
targetUserIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "message": "string",
  • "url": "string",
  • "notifyAt": "2019-08-24T14:15:22Z",
  • "targetUserIds": [
    ]
}

Response samples

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

NotificationV1_delete

通知を削除する

Authorizations:
BearerAuth
path Parameters
id
required
string

通知ID

Responses

MakeupClasses

MakeupClassesV1_list

補講一覧を取得する

Authorizations:
BearerAuth
query Parameters
subjectIds
Array of strings

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

from
string <date>

検索対象開始日付

until
string <date>

検索対象終了日付

Responses

Response samples

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

MakeupClassesV1_create

補講を作成する

Authorizations:
BearerAuth
Request Body schema: application/json
required

作成する補講の情報

subjectId
required
string
date
required
string <date>
period
required
string (DottoFoundationV1.Period)
Enum: "Period1" "Period2" "Period3" "Period4" "Period5" "Period6"
comment
required
string

Responses

Request samples

Content type
application/json
{
  • "subjectId": "string",
  • "date": "2019-08-24",
  • "period": "Period1",
  • "comment": "string"
}

Response samples

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

MakeupClassesV1_fetch

教務システムから補講を取得する

Authorizations:
BearerAuth

Responses

Response samples

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

MakeupClassesV1_delete

補講を削除する

Authorizations:
BearerAuth
path Parameters
id
required
string

補講ID

Responses

RoomChanges

RoomChangesV1_list

教室変更一覧を取得する

Authorizations:
BearerAuth
query Parameters
subjectIds
Array of strings

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

from
string <date>

検索対象開始日付

until
string <date>

検索対象終了日付

Responses

Response samples

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

RoomChangesV1_create

教室変更を作成する

Authorizations:
BearerAuth
Request Body schema: application/json
required

作成する教室変更の情報

subjectId
required
string
date
required
string <date>
period
required
string (DottoFoundationV1.Period)
Enum: "Period1" "Period2" "Period3" "Period4" "Period5" "Period6"
originalRoomId
required
string
newRoomId
required
string

Responses

Request samples

Content type
application/json
{
  • "subjectId": "string",
  • "date": "2019-08-24",
  • "period": "Period1",
  • "originalRoomId": "string",
  • "newRoomId": "string"
}

Response samples

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

RoomChangesV1_fetch

教務システムから教室変更を取得する

Authorizations:
BearerAuth

Responses

Response samples

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

RoomChangesV1_delete

教室変更を削除する

Authorizations:
BearerAuth
path Parameters
id
required
string

教室変更ID

Responses

Rooms

RoomsV1_list

教室一覧を取得する

Authorizations:
BearerAuth
query Parameters
q
string

検索ワード; 部屋名・部屋番号・教員名の部分一致検索される

floors
Array of strings (DottoFoundationV1.Floor)
Items Enum: "Floor1" "Floor2" "Floor3" "Floor4" "Floor5" "Floor6" "Floor7" "Virtual"

階数; 指定した場合は指定した階数の部屋のみを取得する

Responses

Response samples

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

RoomsV1_create

教室を作成する

Authorizations:
BearerAuth
Request Body schema: application/json
required

作成する教室の情報

name
required
string
floor
required
string (DottoFoundationV1.Floor)
Enum: "Floor1" "Floor2" "Floor3" "Floor4" "Floor5" "Floor6" "Floor7" "Virtual"
facultyId
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "floor": "Floor1",
  • "facultyId": "string"
}

Response samples

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

RoomsV1_detail

教室を詳細取得する

Authorizations:
BearerAuth
path Parameters
id
required
string

教室ID

Responses

Response samples

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

RoomsV1_update

教室を更新する

Authorizations:
BearerAuth
path Parameters
id
required
string

教室ID

Request Body schema: application/json
required

更新する教室の情報

name
required
string
floor
required
string (DottoFoundationV1.Floor)
Enum: "Floor1" "Floor2" "Floor3" "Floor4" "Floor5" "Floor6" "Floor7" "Virtual"
facultyId
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "floor": "Floor1",
  • "facultyId": "string"
}

Response samples

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

RoomsV1_delete

教室を削除する

Authorizations:
BearerAuth
path Parameters
id
required
string

教室ID

Responses

Reservations

ReservationsV1_list

教室の予約一覧を取得する 検索対象期間に一部でも重複する予約が取得される

Authorizations:
BearerAuth
query Parameters
roomIds
Array of strings

教室IDのリスト

from
string <date-time>

検索対象開始日時

until
string <date-time>

検索対象終了日時

Responses

Response samples

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

ReservationsV1_create

教室を予約する

Authorizations:
BearerAuth
Request Body schema: application/json
required

予約する教室の情報

roomId
required
string
startAt
required
string <date-time>
endAt
required
string <date-time>
title
required
string

Responses

Request samples

Content type
application/json
{
  • "roomId": "string",
  • "startAt": "2019-08-24T14:15:22Z",
  • "endAt": "2019-08-24T14:15:22Z",
  • "title": "string"
}

Response samples

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

ReservationsV1_detail

予約を詳細取得する

Authorizations:
BearerAuth
path Parameters
id
required
string

予約ID

Responses

Response samples

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

ReservationsV1_delete

予約を削除する

Authorizations:
BearerAuth
path Parameters
id
required
string

予約ID

Responses

Subjects

SubjectsV1_list

科目一覧を取得する

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

Authorizations:
BearerAuth
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"

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

year
integer

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

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:
BearerAuth
path Parameters
id
required
string

科目ID

Responses

Response samples

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

SubjectsV1_delete

科目を削除する

Authorizations:
BearerAuth
path Parameters
id
required
string

科目ID

Responses

TimetableItems

TimetableItemsV1_list

時間割を取得する

Authorizations:
BearerAuth
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
{
  • "items": [
    ]
}

TimetableItemsV1_create

時間割に追加する

Authorizations:
BearerAuth
Request Body schema: application/json
required

追加する時間割の情報

subjectId
required
string
object (DottoFoundationV1.TimetableSlot)
roomIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "subjectId": "string",
  • "slot": {
    },
  • "roomIds": [
    ]
}

Response samples

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

TimetableItemsV1_delete

時間割を削除する

Authorizations:
BearerAuth
path Parameters
id
required
string

時間割ID

Responses

Users

UsersV1_list

ユーザーの一覧を取得する

Authorizations:
BearerAuth

Responses

Response samples

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

UsersV1_detail

ユーザーを取得する

Authorizations:
BearerAuth
path Parameters
id
required
string

ユーザーID

Responses

Response samples

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

UsersV1_upsert

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

Authorizations:
BearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required

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

email
required
string
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
{
  • "email": "string",
  • "grade": "B1",
  • "course": "InformationSystem",
  • "class": "A"
}

Response samples

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

FCM Tokens

FCMTokenV1_list

FCMトークンの一覧を取得する

Authorizations:
BearerAuth
query Parameters
userIds
Array of strings

ユーザーIDの一覧

tokens
Array of strings

FCMトークンの一覧

updatedAtFrom
string <date-time>

更新日時の開始日時 (updatedAt >= updatedAtFrom)

updatedAtTo
string <date-time>

更新日時の終了日時 (updatedAt <= updatedAtTo)

Responses

Response samples

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

FCMTokenV1_upsert

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

Authorizations:
BearerAuth
Request Body schema: application/json
required

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

userId
required
string
token
required
string

Responses

Request samples

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

Response samples

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