-
Notifications
You must be signed in to change notification settings - Fork 0
/
Plannial.Api.xml
50 lines (48 loc) · 1.84 KB
/
Plannial.Api.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
<?xml version="1.0"?>
<doc>
<assembly>
<name>Plannial.Api</name>
</assembly>
<members>
<member name="M:Plannial.Api.Controllers.SubjectsController.AddSubject(Plannial.Core.Requests.AddSubjectRequest,System.Threading.CancellationToken)">
<summary>
Adds a new subject
</summary>
<remarks>
Sample request:
POST /Subject
{
"name":"Math",
"description:"not so fun"
}
POST /Subject
{
"name":"Math"
}
</remarks>
<param name="addSubjectRequest"></param>
<param name="cancellationToken"></param>
<returns>A newly created subject</returns>
<response code="201">Returns the newly created item</response>
<response code="400">In case of validation errors or if the database was not able to add the item</response>
</member>
<member name="M:Plannial.Api.Controllers.SubjectsController.AddSubjectGrade(Plannial.Core.Requests.AddGradeRequest,System.Int32,System.Threading.CancellationToken)">
<summary>
Adds a grade to a subject
</summary>
<remarks>
Sample request:
POST /Subject/grade
{
grade:"A"
}
</remarks>
<param name="addGradeRequest"></param>
<param name="subjectId"></param>
<param name="cancellationToken"></param>
<returns></returns>
<response code="204">Set the subject's grade successfully</response>
<response code="404">Could not find the specified subject</response>
</member>
</members>
</doc>