Academic Service (1.0.0)

Download OpenAPI specification:

Subjects

SubjectsV1_list

科目一覧を取得する

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

query Parameters

ids	Array of strings 科目IDのリスト; 指定した場合は指定した科目IDのみを取得する
q	string 検索ワード
grade	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" コース; 大学院の場合は大学院コースに読み替え
class	Array of strings (DottoFoundationV1.Class) Items Enum: "A" "B" "C" "D" "E" "F" "G" "H" "I" "J" "K" "L" クラス; 大学院の学年を選択した場合は選択できない
classification	Array of strings (DottoFoundationV1.SubjectClassification) Items Enum: "Specialized" "Cultural" "ResearchInstruction" 学部: 専門・教養; 大学院: 専門・研究指導
year	integer 開講年度; 指定しない場合は今年度が選択される
semester	Array of strings (DottoFoundationV1.CourseSemester) Items Enum: "AllYear" "H1" "H2" "Q1" "Q2" "Q3" "Q4" "SummerIntensive" "WinterIntensive" 開講時期
requirementType	Array of strings (DottoFoundationV1.SubjectRequirementType) Items Enum: "Required" "Optional" "OptionalRequired" 必修・選択・選択必修
culturalSubjectCategory	Array of strings (DottoFoundationV1.CulturalSubjectCategory) Items Enum: "Society" "Human" "Science" "Health" "Communication" 教養科目カテゴリ

Responses

Response samples

200

Content type

application/json

{"subjects": [{"id": "string",
"name": "string",
"faculties": [{"faculty": {"id": "string",
"name": "string",
"email": "string"
},
"isPrimary": true
}
]
}
]
}

SubjectsV1_upsert

科目を作成または更新する

Request Body schema: application/json
required

作成または更新する科目の情報

syllabusId

required

string

Responses

Request samples

Payload

Content type

application/json

{"syllabusId": "string"
}

Response samples

200

Content type

application/json

{"subject": {"id": "string",
"name": "string",
"faculties": [{"faculty": {"id": "string",
"name": "string",
"email": "string"
},
"isPrimary": true
}
],
"year": 0,
"semester": "AllYear",
"credit": 0,
"eligibleAttributes": [{"grade": "B1",
"class": "A"
}
],
"requirements": [{"course": "InformationSystem",
"requirementType": "Required"
}
]
}
}

SubjectsV1_detail

科目を詳細取得する

path Parameters

id

required

string

科目ID

Responses

Response samples

200

Content type

application/json

{"subject": {"id": "string",
"name": "string",
"faculties": [{"faculty": {"id": "string",
"name": "string",
"email": "string"
},
"isPrimary": true
}
],
"year": 0,
"semester": "AllYear",
"credit": 0,
"eligibleAttributes": [{"grade": "B1",
"class": "A"
}
],
"requirements": [{"course": "InformationSystem",
"requirementType": "Required"
}
]
}
}

SubjectsV1_delete

科目を削除する

path Parameters

id

required

string

科目ID

Responses

Syllabus

SyllabusV1_detail

シラバスを取得する

path Parameters

id

required

string

科目ID

Responses

Local

http://localhost:8080/v1/subjects/{id}/syllabus

Development

https://academic-api-dev-107577467292.asia-northeast1.run.app/v1/subjects/{id}/syllabus

Staging

https://academic-api-stg-107577467292.asia-northeast1.run.app/v1/subjects/{id}/syllabus

QA

https://academic-api-qa-107577467292.asia-northeast1.run.app/v1/subjects/{id}/syllabus

Production

https://academic-api-107577467292.asia-northeast1.run.app/v1/subjects/{id}/syllabus

Response samples

200

Content type

application/json

{"syllabus": {"id": "string",
"name": "string",
"enName": "string",
"grades": "string",
"credit": 0,
"facultyNames": "string",
"practicalHomeFacultyCategory": "string",
"multiplePersonTeachingForm": "string",
"teachingForm": "string",
"summary": "string",
"learningOutcomes": "string",
"assignments": "string",
"evaluationMethod": "string",
"textbooks": "string",
"referenceBooks": "string",
"prerequisites": "string",
"preLearning": "string",
"postLearning": "string",
"notes": "string",
"keywords": "string",
"targetCourses": "string",
"targetAreas": "string",
"classifications": "string",
"teachingLanguage": "string",
"contentsAndSchedule": "string",
"teachingAndExamForm": "string",
"dsopSubject": "string"
}
}

Faculties

FacultiesV1_list

教員一覧を取得する

query Parameters

ids	Array of strings 教員IDのリスト; 指定した場合は指定した教員IDのみを取得する

Responses

Response samples

200

Content type

application/json

{"faculties": [{"id": "string",
"name": "string",
"email": "string"
}
]
}

FacultiesV1_create

教員を作成する

Request Body schema: application/json
required

作成する教員の情報

name required	string
email required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"email": "string"
}

Response samples

201

Content type

application/json

{"faculty": {"id": "string",
"name": "string",
"email": "string"
}
}

FacultiesV1_detail

教員を詳細取得する

path Parameters

id

required

string

教員ID

Responses

Response samples

200

Content type

application/json

{"faculty": {"id": "string",
"name": "string",
"email": "string"
}
}

FacultiesV1_update

教員を更新する

path Parameters

id

required

string

教員ID

Request Body schema: application/json
required

更新する教員の情報

name required	string
email required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"email": "string"
}

Response samples

200

Content type

application/json

{"faculty": {"id": "string",
"name": "string",
"email": "string"
}
}

FacultiesV1_delete

教員を削除する

path Parameters

id

required

string

教員ID

Responses

CourseRegistrations

CourseRegistrationsV1_list

履修情報を取得する

query Parameters

userId required	string ユーザーID
year	integer 開講年度; 指定しない場合は今年度が選択される
semester required	string (DottoFoundationV1.CourseSemester) Enum: "AllYear" "H1" "H2" "Q1" "Q2" "Q3" "Q4" "SummerIntensive" "WinterIntensive" 開講時期

Responses

Local

http://localhost:8080/v1/courseRegistrations

Development

https://academic-api-dev-107577467292.asia-northeast1.run.app/v1/courseRegistrations

Staging

https://academic-api-stg-107577467292.asia-northeast1.run.app/v1/courseRegistrations

QA

https://academic-api-qa-107577467292.asia-northeast1.run.app/v1/courseRegistrations

Production

https://academic-api-107577467292.asia-northeast1.run.app/v1/courseRegistrations

Response samples

200

Content type

application/json

{"courseRegistrations": [{"id": "string",
"userId": "string",
"subject": {"id": "string",
"name": "string",
"faculties": [{"faculty": {"id": "string",
"name": "string",
"email": "string"
},
"isPrimary": true
}
]
}
}
]
}

CourseRegistrationsV1_create

履修情報を作成する

Request Body schema: application/json
required

作成する履修情報の情報

userId required	string
subjectId required	string

Responses

Local

http://localhost:8080/v1/courseRegistrations

Development

https://academic-api-dev-107577467292.asia-northeast1.run.app/v1/courseRegistrations

Staging

https://academic-api-stg-107577467292.asia-northeast1.run.app/v1/courseRegistrations

QA

https://academic-api-qa-107577467292.asia-northeast1.run.app/v1/courseRegistrations

Production

https://academic-api-107577467292.asia-northeast1.run.app/v1/courseRegistrations

Request samples

Payload

Content type

application/json

{"userId": "string",
"subjectId": "string"
}

Response samples

201

Content type

application/json

{"courseRegistration": {"id": "string",
"userId": "string",
"subject": {"id": "string",
"name": "string",
"faculties": [{"faculty": {"id": "string",
"name": "string",
"email": "string"
},
"isPrimary": true
}
]
}
}
}

CourseRegistrationsV1_delete

履修情報を削除する

path Parameters

id

required

string

履修情報ID

Responses

Local

http://localhost:8080/v1/courseRegistrations/{id}

Development

https://academic-api-dev-107577467292.asia-northeast1.run.app/v1/courseRegistrations/{id}

Staging

https://academic-api-stg-107577467292.asia-northeast1.run.app/v1/courseRegistrations/{id}

QA

https://academic-api-qa-107577467292.asia-northeast1.run.app/v1/courseRegistrations/{id}

Production

https://academic-api-107577467292.asia-northeast1.run.app/v1/courseRegistrations/{id}

TimetableItems

TimetableItemsV1_list

時間割を取得する

query Parameters

year	integer 開講年度; 指定しない場合は今年度が選択される
semester required	string (DottoFoundationV1.CourseSemester) Enum: "AllYear" "H1" "H2" "Q1" "Q2" "Q3" "Q4" "SummerIntensive" "WinterIntensive" 開講時期
dayOfWeek	Array of strings (DottoFoundationV1.DayOfWeek) Items Enum: "Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" 曜日; 複数指定時はORでフィルタリングされる; 指定しない場合は全ての曜日が選択される

Responses

Response samples

200

Content type

application/json

{"timetableItems": [{"id": "string",
"subject": {"id": "string",
"name": "string",
"faculties": [{"faculty": {"id": "string",
"name": "string",
"email": "string"
},
"isPrimary": true
}
]
},
"dayOfWeek": "Sunday",
"period": "Period1"
}
]
}

TimetableItemsV1_create

時間割に追加する

Request Body schema: application/json
required

追加する時間割の情報

subjectId required	string
dayOfWeek required	string (DottoFoundationV1.DayOfWeek) Enum: "Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"
period required	string (DottoFoundationV1.Period) Enum: "Period1" "Period2" "Period3" "Period4" "Period5" "Period6"

Responses

Request samples

Payload

Content type

application/json

{"subjectId": "string",
"dayOfWeek": "Sunday",
"period": "Period1"
}

Response samples

201

Content type

application/json

{"timetableItem": {"id": "string",
"subject": {"id": "string",
"name": "string",
"faculties": [{"faculty": {"id": "string",
"name": "string",
"email": "string"
},
"isPrimary": true
}
]
},
"dayOfWeek": "Sunday",
"period": "Period1"
}
}

TimetableItemsV1_delete

時間割を削除する

path Parameters

id

required

string

時間割ID

Responses

Local

http://localhost:8080/v1/timetableItems/{id}

Development

https://academic-api-dev-107577467292.asia-northeast1.run.app/v1/timetableItems/{id}

Staging

https://academic-api-stg-107577467292.asia-northeast1.run.app/v1/timetableItems/{id}

QA

https://academic-api-qa-107577467292.asia-northeast1.run.app/v1/timetableItems/{id}

Production

https://academic-api-107577467292.asia-northeast1.run.app/v1/timetableItems/{id}

Rooms

RoomsV1_list

教室一覧を取得する

query Parameters

ids	Array of strings 教室IDのリスト; 指定した場合は指定した教室IDのみを取得する
floor	Array of strings (DottoFoundationV1.Floor) Items Enum: "Floor1" "Floor2" "Floor3" "Floor4" "Floor5" "Floor6" "Floor7" 階数; 指定した場合は指定した階数の教室のみを取得する

Responses

Response samples

200

Content type

application/json

{"rooms": [{"id": "string",
"name": "string",
"floor": "Floor1"
}
]
}

RoomsV1_create

教室を作成する

Request Body schema: application/json
required

作成する教室の情報

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

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"floor": "Floor1"
}

Response samples

201

Content type

application/json

{"room": {"id": "string",
"name": "string",
"floor": "Floor1"
}
}

RoomsV1_detail

教室を詳細取得する

path Parameters

id

required

string

教室ID

Responses

Response samples

200

Content type

application/json

{"room": {"id": "string",
"name": "string",
"floor": "Floor1"
}
}

RoomsV1_update

教室を更新する

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"

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"floor": "Floor1"
}

Response samples

200

Content type

application/json

{"room": {"id": "string",
"name": "string",
"floor": "Floor1"
}
}

RoomsV1_delete

教室を削除する

path Parameters

id

required

string

教室ID

Responses

Reservations

ReservationsV1_list

教室の予約一覧を取得する

path Parameters

id

required

string

教室ID

query Parameters

from	string <date-time> 開始日時
until	string <date-time> 終了日時

Responses

Local

http://localhost:8080/v1/rooms/{id}/reservations

Development

https://academic-api-dev-107577467292.asia-northeast1.run.app/v1/rooms/{id}/reservations

Staging

https://academic-api-stg-107577467292.asia-northeast1.run.app/v1/rooms/{id}/reservations

QA

https://academic-api-qa-107577467292.asia-northeast1.run.app/v1/rooms/{id}/reservations

Production

https://academic-api-107577467292.asia-northeast1.run.app/v1/rooms/{id}/reservations

Response samples

200

Content type

application/json

{"reservations": [{"startAt": "2019-08-24T14:15:22Z",
"endAt": "2019-08-24T14:15:22Z",
"title": "string"
}
]
}

Academic Service (1.0.0)

Subjects

SubjectsV1_list

query Parameters

Responses

Response samples

SubjectsV1_upsert

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

SubjectsV1_detail

path Parameters

Responses

Response samples

SubjectsV1_delete

path Parameters

Responses

Syllabus

SyllabusV1_detail

path Parameters

Responses

Response samples

Faculties

FacultiesV1_list

query Parameters

Responses

Response samples

FacultiesV1_create

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

FacultiesV1_detail

path Parameters

Responses

Response samples

FacultiesV1_update

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

FacultiesV1_delete

path Parameters

Responses

CourseRegistrations

CourseRegistrationsV1_list

query Parameters

Responses

Response samples

CourseRegistrationsV1_create

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

CourseRegistrationsV1_delete

path Parameters

Responses

TimetableItems

TimetableItemsV1_list

query Parameters

Responses

Response samples

TimetableItemsV1_create

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

TimetableItemsV1_delete

path Parameters

Responses

Rooms

RoomsV1_list

query Parameters

Responses

Response samples

RoomsV1_create

Request Body schema: application/jsonrequired

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required