diff --git a/python_algorithms/RESTful/API.txt b/python_algorithms/RESTful/API.txt deleted file mode 100644 index cfb3c6b..0000000 --- a/python_algorithms/RESTful/API.txt +++ /dev/null @@ -1,132 +0,0 @@ - - -http Methods: -GET - get ressource -POST - create a new ressource -DELETE - deleting ressources - - -collection: /status - * GET - - * POST - * DELETE - - -## Getting the state of NewGon: - -**Definition** -'GET /status' - -**Responses** -- '200 OK' - on success - -'''json -{ - "MODE":1, - "STATUS":"Ready", - "SHX":0, - "SHY":0, - "SHZ":18, - "CHI":10, - "PHI":0, - "OMEGA":0, - "OX":0, - "OY":0, - "OZ":0, - "s1":12, - "s2":13, - "s3":14, - "s4":15, - "phimotor":11, - "cyclecount":123456789 -} -''' - - -## Setting the variables to NewGon -**Definition** -'POST /status' - -**Arguments** -{ - "MODE":1, - "STATUS":"Ready", - "SHX":0, - "SHY":0, - "SHZ":18, - "CHI":10, - "PHI":0, - "OMEGA":0, - "OX":0, - "OY":0, - "OZ":0, - "s1":12, - "s2":13, - "s3":14, - "s4":15, - "phimotor":11, - "cyclecount":123456789 -} - - - - - - - -GET /status - -{ - "MODE":1, - "STATUS":"Ready", - "SHX":0, - "SHY":0, - "SHZ":18, - "CHI":10, - "PHI":0, - "OMEGA":0, - "OX":0, - "OY":0, - "OZ":0, - "s1":12, - "s2":13, - "s3":14, - "s4":15, - "phimotor":11, - "cyclecount":123456789 -} - - -GET /params -{ - "l1':1, - "l2':1, - "l3':1, - "l4':1, - "l5':1, - "l6':1, - -} - - -PUT /set - -{ - "SHX":1 -} - -or - -{ - "SHX":2.2, - "SHY":1.1 -} - -returns - -{ - "SHX":2.2 - "message":"SHX->2.2." -} - -