smargopolo/python_algorithms/RESTful/RESTAPI.md

RESTful API for NewGon:

http Methods:

• GET - get ressource
• POST - create a new ressource
• DELETE - deleting ressources

GETTING information

Getting the full status of NewGon:

Definition

`GET /newgon

Responses

• 200 OK - on success

{
   "MODE":1,
   "STATUS":"Ready",
   "target": {
       "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,
       "omegamotor":180
   },
   "readback": {
       "s1":12,
       "s2":13,
       "s3":14,
       "s4":15,
       "phimotor":11,
       "omegamotor":180
    },
    "cyclecount":123456789
}

Getting target values of NewGon:

Definition

GET /newgon/target

Response

• 200 OK on success

{
    "target": {
       "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,
       "omegamotor":180
   }
}

SETTING INFORMATION

Setting many 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
}

Responses

• 200 OK - on success
• 404 Not Found if the variable does not exist

Setting individual varibles to NewGon

Definition

POST /status

Arguments

{
   "MODE":1,
   "SHX":2
}

{ "SHX":2.2 "message":"SHX->2.2." }