API docs by Redocly

Admin BFF Service (1.0.0)

Download OpenAPI specification:

Announcements

AnnouncementsV1_list

Responses

Response samples

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

AnnouncementsV1_create

おしらせを作成する

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

おしらせを詳細取得する

path Parameters
id
required
string

おしらせID

Responses

Response samples

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

AnnouncementsV1_update

おしらせを更新する

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

おしらせを削除する

path Parameters
id
required
string

おしらせID

Responses

Courses

CoursesV1_list

コース一覧を取得する

Responses

Response samples

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

CoursesV1_create

コースを作成する

Request Body schema: application/json
required

作成するコースの情報

name
required
string

Responses

Request samples

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

Response samples

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

CoursesV1_detail

コースを詳細取得する

path Parameters
id
required
string

コースID

Responses

Response samples

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

CoursesV1_update

コースを更新する

path Parameters
id
required
string

コースID

Request Body schema: application/json
required

更新するコースの情報

name
required
string

Responses

Request samples

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

Response samples

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

CoursesV1_delete

コースを削除する

path Parameters
id
required
string

コースID

Responses

Faculties

FacultiesV1_list

教員一覧を取得する

Responses

Response samples

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

FacultiesV1_create

教員を作成する

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

教員を詳細取得する

path Parameters
id
required
string

教員ID

Responses

Response samples

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

FacultiesV1_update

教員を更新する

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

教員を削除する

path Parameters
id
required
string

教員ID

Responses

DayOfWeekTimetableSlots

DayOfWeekTimetableSlotsV1_list

曜日・時限一覧を取得する

Responses

Response samples

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

DayOfWeekTimetableSlotsV1_create

曜日・時限を作成する

Request Body schema: application/json
required

作成する曜日・時限の情報

dayOfWeek
required
string (DottoFoundationV1.DayOfWeek)
Enum: "Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"
timetableSlot
required
string (DottoFoundationV1.TimetableSlot)
Enum: "Slot1" "Slot2" "Slot3" "Slot4" "Slot5" "Slot6"

授業時間

Responses

Request samples

Content type
application/json
{
  • "dayOfWeek": "Sunday",
  • "timetableSlot": "Slot1"
}

Response samples

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

DayOfWeekTimetableSlotsV1_detail

曜日・時限を詳細取得する

path Parameters
id
required
string

曜日・時限ID

Responses

Response samples

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

DayOfWeekTimetableSlotsV1_update

曜日・時限を更新する

path Parameters
id
required
string

曜日・時限ID

Request Body schema: application/json
required

更新する曜日・時限の情報

dayOfWeek
required
string (DottoFoundationV1.DayOfWeek)
Enum: "Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"
timetableSlot
required
string (DottoFoundationV1.TimetableSlot)
Enum: "Slot1" "Slot2" "Slot3" "Slot4" "Slot5" "Slot6"

授業時間

Responses

Request samples

Content type
application/json
{
  • "dayOfWeek": "Sunday",
  • "timetableSlot": "Slot1"
}

Response samples

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

DayOfWeekTimetableSlotsV1_delete

曜日・時限を削除する

path Parameters
id
required
string

曜日・時限ID

Responses

SubjectCategories

SubjectCategoriesV1_list

科目群・科目区分一覧を取得する

Responses

Response samples

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

SubjectCategoriesV1_create

科目群・科目区分を作成する

Request Body schema: application/json
required

作成する科目群・科目区分の情報

name
required
string

Responses

Request samples

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

Response samples

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

SubjectCategoriesV1_detail

科目群・科目区分を詳細取得する

path Parameters
id
required
string

科目群・科目区分ID

Responses

Response samples

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

SubjectCategoriesV1_update

科目群・科目区分を更新する

path Parameters
id
required
string

科目群・科目区分ID

Request Body schema: application/json
required

更新する科目群・科目区分の情報

name
required
string

Responses

Request samples

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

Response samples

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

SubjectCategoriesV1_delete

科目群・科目区分を削除する

path Parameters
id
required
string

科目群・科目区分ID

Responses

Subjects

SubjectsV1_list

科目一覧を取得する

Responses

Response samples

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

SubjectsV1_create

科目を作成する

Request Body schema: application/json
required

作成する科目の情報

name
required
string
required
Array of objects (SubjectService.SubjectFacultyRequest)
semester
required
string (DottoFoundationV1.CourseSemester)
Enum: "AllYear" "H1" "H2" "Q1" "Q2" "Q3" "Q4" "SummerIntensive" "WinterIntensive"

開講時期

dayOfWeekTimetableSlotIds
required
Array of strings
credit
required
integer
required
Array of objects (SubjectService.SubjectTargetClass)
required
Array of objects (SubjectService.SubjectRequirementRequest)
categoryIds
required
Array of strings
syllabusId
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "faculties": [
    ],
  • "semester": "AllYear",
  • "dayOfWeekTimetableSlotIds": [
    ],
  • "credit": 0,
  • "eligibleAttributes": [
    ],
  • "requirements": [
    ],
  • "categoryIds": [
    ],
  • "syllabusId": "string"
}

Response samples

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

SubjectsV1_detail

科目を詳細取得する

path Parameters
id
required
string

科目ID

Responses

Response samples

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

SubjectsV1_update

科目を更新する

path Parameters
id
required
string

科目ID

Request Body schema: application/json
required

更新する科目の情報

name
required
string
required
Array of objects (SubjectService.SubjectFacultyRequest)
semester
required
string (DottoFoundationV1.CourseSemester)
Enum: "AllYear" "H1" "H2" "Q1" "Q2" "Q3" "Q4" "SummerIntensive" "WinterIntensive"

開講時期

dayOfWeekTimetableSlotIds
required
Array of strings
credit
required
integer
required
Array of objects (SubjectService.SubjectTargetClass)
required
Array of objects (SubjectService.SubjectRequirementRequest)
categoryIds
required
Array of strings
syllabusId
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "faculties": [
    ],
  • "semester": "AllYear",
  • "dayOfWeekTimetableSlotIds": [
    ],
  • "credit": 0,
  • "eligibleAttributes": [
    ],
  • "requirements": [
    ],
  • "categoryIds": [
    ],
  • "syllabusId": "string"
}

Response samples

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

SubjectsV1_delete

科目を削除する

path Parameters
id
required
string

科目ID

Responses