Update New Restful Plan authored by Derek Williams's avatar Derek Williams
| Endpoint | Type | Example(s) | | Endpoint | Type | Example(s) |
|----------|------|------------| |----------|:----:|----------|
| /login | POST | [Login - Successful](New-Restful-Plan#login-successful) <br></br> [Login - Failed](New-Restful-Plan#login-failed) | | /login | POST | [Successful](New-Restful-Plan#login-successful) <br></br> [Failed](New-Restful-Plan#login-failed) |
| /logout/{playerID} | GET | | | /logout | POST | [Successful](New-Restful-Plan#logout-successful) |
| /quest | GET | | | /quests | GET | [Successful](New-Restful-Plan#quest-list) |
| /quest/create | POST | | | /quests/create | POST | |
| /quest/{questID} | GET | | | /quests/{questID} | GET | |
| /quest/{questID}/{playerID} | GET | | | /quests/{questID}/objectives | GET | |
| /quest/{questID}/objective | GET | | | /quests/{questID}/objectives/create | POST | |
| /quest/{questID}/objective/create | POST | | | /quests/{questID}/objectives/{objectiveID} | GET | |
| /quest/{questID}/objective/{objectiveID} | GET | | | /quests/{questID}/objectives/{objectiveID}/complete | POST | |
| /quest/{questID}/objective/{objectiveID}/complete | POST | | | /players | GET | |
| /objective-complete | POST | | | /players/create | POST | |
| /objective-fetch-all/{playerID} | GET | | | /players/{playerID} | GET | |
| /player | POST | | | /players/{playerID}/quests | GET | |
| /players/{playerID}/quests/{questID} | GET | |
# Login - Successful # Login - Successful
This endpoint is responsible for logging in players. A payload consisting of a username/password combination is required. This is an example of a successful login request.
This endpoint is responsible to logging in players. A payload consisting of a username/password combination is required. This is an example of a successful login request.
## Request ## Request
```http ```http
POST /login POST /login
``` ```
## Payload ## Payload
```json ```json
{ {
"username": "guest", "username": "guest",
...@@ -35,7 +33,6 @@ POST /login ...@@ -35,7 +33,6 @@ POST /login
``` ```
## Response ## Response
```json ```json
{ {
"playerID": 41 "playerID": 41
...@@ -43,17 +40,14 @@ POST /login ...@@ -43,17 +40,14 @@ POST /login
``` ```
# Login - Failed # Login - Failed
This is an example of a failed login request. This is an example of a failed login request.
## Request ## Request
```http ```http
POST /login POST /login
``` ```
## Payload ## Payload
```json ```json
{ {
"username": "guest", "username": "guest",
...@@ -62,37 +56,37 @@ POST /login ...@@ -62,37 +56,37 @@ POST /login
``` ```
## Response ## Response
```json ```json
{ {
"message": "Player: guest failed to login." "message": "Player: guest failed to login."
} }
``` ```
# Logout # Logout - Success
## Request ## Request
```http ```http
GET /logout/41 POST /logout
``` ```
## Response ## Payload
```json
{
"playerID": 41
}
```
## Response
```plaintext ```plaintext
Player 41 logged out. Player 41 logged out.
``` ```
# Quest List # Quest List
## Request ## Request
```http ```http
GET /quest GET /quest
``` ```
## Response ## Response
```json ```json
{ {
"1": { "1": {
... ...
......