gameplay/docket/

This endpoint handles a docket of requests, alerts and other things for/by players.

Methods & Response Codes

• GET
  • docket/requests/ returns all requests
  • docket/requests/status/{status}/ returns all requests with a specific status
    • 204: no requests with that status
    • 400: invalid status
  • docket/requests/user/{username}/ returns all requests from a specific user
    • 204: no requests from that user
    • 404: user not found
  • docket/requests/full/, returns TRUE if storage of pending requests is full
• POST
  • docket/requests/request/ submits a new request
    • 507: storage of pending requests is full => auto-calls API discord/log/ => disables all types of requests on the Request Model via API model/
• PATCH
  • docket/requests/request/ updates a pending request
    • 404: pending request not found

Fields

GET docket/requests/status/{status}/

• "pending"
• "completed" (approved + declined)
• "approved"
• "declined"
• "cancelled"

POST docket/requests/request/

See the Request Model.

PATCH docket/requests/request/

• * key => key of the pending request
• * handler
• * status => "approved" | "declined" | "cancelled"
• explanation => max 240 characters

Notes

• Stores a maximum of 100 total pending requests and 100 total completed requests
• Currently limited to requests

---

< Back to docs / api