Update New Restful Plan authored by Derek Williams's avatar Derek Williams
| Endpoint | Type | Example(s) |
|----------|:----:|----------|
| /login | POST | [Successful](New-Restful-Plan#login-successful) <br></br> [Failed](New-Restful-Plan#login-failed) |
| /logout | POST | [Successful](New-Restful-Plan#logout-successful) <br></br> [Failed](New-Restful-Plan#logout-failed)|
| /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 | |
| /quests/create | POST | [Successful](New-Restful-Plan#create-quest) |
| /quests/{questID} | GET | [Successful](New-Restful-Plan#get-quest-info) |
| /quests/{questID}/objectives/create | POST | [Successful](New-Restful-Plan#create-objective) |
| /quests/{questID}/objectives/{objectiveID} | GET | [Successful](New-Restful-Plan#get-objective-info) |
| /quests/{questID}/objectives/{objectiveID}/complete | POST | [Successful](New-Restful-Plan#complete-objective) |
| /players | GET | [Successful](New-Restful-Plan#player-list) |
| /players/create | POST | |
| /players/{playerID} | GET | |
| /players/{playerID}/quests | GET | [Successful](New-Restful-Plan#quest-list-for-player)|
| /players/{playerID}/quests/{questID} | GET | |
| /players/create | POST | [Successful](New-Restful-Plan#create-player) |
| /players/{playerID} | GET | [Successful](New-Restful-Plan#get-player-info) |
| /players/{playerID}/quests | GET | [Successful](New-Restful-Plan#quest-list-for-player) |
| /players/{playerID}/quests/{questID} | GET | [Successful](New-Restful-Plan#get-player-quest-info) |
# Login - Successful
......@@ -124,6 +124,96 @@ GET /quest
}
```
# Create Quest
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 /quests/create
```
## Payload
```json
```
## Response
```json
```
# Get Quest Info
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
GET /quests/1
```
## Payload
```json
```
## Response
```json
```
# Create Objective
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 /quests/1/objectives/create
```
## Payload
```json
```
## Response
```json
```
# Get Objective Info
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
GET /quests/1/objectives/1
```
## Payload
```json
```
## Response
```json
```
# Complete Objective
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 /quests/1/objectives/1/complete
```
## Payload
```json
```
## Response
```json
```
# Player List
## Request
```http
......@@ -148,6 +238,42 @@ GET /players
}
```
# Create Player
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 /players/create
```
## Payload
```json
```
## Response
```json
```
# Get Player Info
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
GET /players/41
```
## Payload
```json
```
## Response
```json
```
# Quest List For Player
## Request
```http
......@@ -172,4 +298,22 @@ GET /players/41/quests
"endDate": "9999-12-30"
}
}
```
# Get Player Quest Info
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
GET /players/41/quests/1
```
## Payload
```json
```
## Response
```json
```
\ No newline at end of file