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