Difference between revisions of "W3911 Sudoku Server"

From Coder Merlin
Line 29: Line 29:
|responseExample={"id": 728134}
|responseExample={"id": 728134}
}}
}}
 
{{RestAPI
* PUT /games/<id>/cells/<boxIndex>/<cellIndex>
|endpoint=PUT /games/<id>/cells/<boxIndex>/<cellIndex>
    * Action: Place specified value at in game at boxIndex, cellIndex
|action=Place specified value at in game at boxIndex, cellIndex
    * Payload: value (null for removing value)
|parameters=<span style="font-style: italic;">none</span>
    * Response: Nothing
|body=value (null for removing value)
    * Status: 204 No Content
|statusCode=200 OK
|response=<span style="font-style: italic;">none</span>
|responseExample=<span style="font-style: italic;">none</span>
}}


=== JSON Encoding ===
=== JSON Encoding ===

Revision as of 07:58, 7 October 2021

Within these castle walls be forged Mavens of Computer Science ...
— Merlin, The Coder

Background A Sudoku board is made up of nine boxes. Boxes (container for nine cells) are listed from top-to-bottom, left-to-right indexed from zero. Cells are listed from top-to-bottom, left-to-right, indexed from zero. All valid payloads and responses must use well-formed JSON. “cells” is returned as follows: “cells”: [[<nine values from top-left>], [<nine values from top-middle>], …]

End Points


POST /games?difficulty=<difficulty>
Creates a new game and associated board
   Parameters: 
   difficulty: easy | medium | hard | hell
   Body: none
   Status code: 201 Created
   Response: ID (integer) of newly created game
   {"id":<id>}
   
{"id": 728134}
   Errors:
   
{{{errors}}}



GET /games/<id>/cells
Returns the current cells for the specified game
   Parameters: 
   none
   Body: none
   Status code: 200 OK
   Response: Cells
   {"id":<id>}
   
{"id": 728134}
   Errors:
   
{{{errors}}}



PUT /games/<id>/cells/<boxIndex>/<cellIndex>
Place specified value at in game at boxIndex, cellIndex
   Parameters: 
   none
   Body: value (null for removing value)
   Status code: 200 OK
   Response: none
   
none
   Errors:
   
{{{errors}}}


JSON Encoding[edit]

CoderMerlin™ Code Explorer: W0000 (1) 🟢

JSON Decoding[edit]

CoderMerlin™ Code Explorer: W0000 (2) 🟢

Issue Request from Client to Server[edit]

CoderMerlin™ Code Explorer: W0000 (3) 🟢