Skip to content

Commit

Permalink
updated endpoints to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
alxford45 committed Nov 29, 2020
1 parent 1a7f30c commit e7fd6a8
Showing 1 changed file with 47 additions and 1 deletion.
48 changes: 47 additions & 1 deletion api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,27 +140,31 @@ Get all users

```
GET /api​/user
req: none
res: body: {UserDTO[]}
```

Get all users who are admins

```
GET /api​/user/admin
req: none
res: body: {UserDTO[]}
```

Get all users who are not admins

```
GET /api​/user/student
req: none
res: body: {UserDTO[]}
```

Get user by lsu_id

```
GET /api​/user/{lsu_id}
req: none
res: body: {UserDTO}
```

Expand All @@ -178,27 +182,31 @@ Get all assignments

```
GET /api/assignment
req: none
res: body: {AssignmentDTO}
```

Get all assignments assigned to admin by lsu_id

```
GET /api/assignment/user/{lsu_id}
req: none
res: body: {AssignmentDTO[]}
```

Get all assignments assigned to ticket by ticket_id

```
GET /api/assignment/ticket/{ticket_id}
req: none
res: body: {AssignmentDTO[]}
```

Get one assignment by assignment_id

```
GET /api/assignment/{assignment_id}
req: none
res: body: {AssignmentDTO}
```

Expand All @@ -212,4 +220,42 @@ res: body: {AssignmentDTO}

## Work

TODO
Get all work

```
GET /api/work
req: none
res: body: {WorkDTO[]}
```

Get all work by ticket_id

```
GET /api/work/ticket/{ticket_id}
req: none
res: body: {WorkDTO[]}
```

Get all work by lsu_id

```
GET /api/work/user/{lsu_id}
req: none
res: body: {WorkDTO[]}
```

Get work by work_id

```
GET /api/work/{work_id}
req: none
res: body: {WorkDTO}
```

Post new work

```
POST /api/work
req: body: {CreateWorkDTO}
res: body: {WorkDTO}
```

0 comments on commit e7fd6a8

Please sign in to comment.