Traffic Editor API

Docker image available on dockerhub: docker pull weijuin/go-task:v1.9

Graph

1. POST - /editor/graph

Description: Create new graph

2. PUT - /editor/graph/detailed/

Description: Update one graph

{
   "mapVerID": "b2a546f9-b7a1-4623-8c93-8a574b8db1f6",
   "scale": 0.05,
   "Location": "NCS A1",
   "Building": "NCS",
   "level": "1",
   "lanes": {
       "0.0": {"1.0": 58.54130575371151},
       "0.1": {"1.0": 58.54130575371151},
       "1.0": {"0.0": 58.54130575371151, "2.0": 55.643275340786325},
       "1.0": {"0.1": 58.54130575371151, "2.0": 55.643275340786325},
       "2.0": {"1.0": 55.643275340786325, "3.0": 479.9329727520787},
       "3.0": {"2.0": 479.9329727520787, "4.0": 259.0517327067432, "6.0": 214.95190436162838},
       "4.0": {"3.0": 259.0517327067432, "5.0": 226.86823068055912},
       "5.0": {"4.0": 226.86823068055912, "6.0": 254.25660341657715},
       "6.0": {"3.0": 214.95190436162838, "5.0": 254.25660341657715}
   },
   "vertices": {
       "0": {"x": 35.57377049180328, "y": 727.8171428571429, "type": 0, "name": "Home", "intersectionDegree": 2},
       "0.0": {"x": 35.57377049180328, "y": 727.8171428571429, "type": 0, "name": "Home", "intersectionDegree": 2},
       "0.1": {"x": 35.57377049180328, "y": 727.8171428571429, "type": 0, "name": "Home", "intersectionDegree": 2},
       "1": {"x": 94.09931253626547, "y": 729.1756007149452, "type": 1, "name": "A", "intersectionDegree": 2},
       "2": {"x": 95.24531538675106, "y": 784.8070735348988, "type": 2, "name": "B", "intersectionDegree": 2},
       "3": {"x": 574.9178003414773, "y": 800.6173711919746, "type": 0, "name": "C", "intersectionDegree": 2},
       "4": {"x": 593.2786885245902, "y": 542.2171428571429, "type": 0, "name": "D", "intersectionDegree": 4},
       "5": {"x": 819.4102139602585, "y": 560.4853473738731, "type": 0, "name": "E", "intersectionDegree": 2},
       "6": {"x": 789.5140055094371, "y": 812.9781930174668, "type": 0, "name": "F", "intersectionDegree": 2}
   }
}

Attributes:

• "type": 0 = null
• "type": 1 = door
• "type": 2 = elevator
• "type": 3 = waiting point Parent node "0" has a capacity of 2. Child nodes are "0.0" and "0.1"

3. GET - /editor/graph/detailed

Description: Get all graphs(All details)

4. GET - /editor/graph/nondetailed

Description: Get all graphs(Names and location only)

5. GET - /editor/graph/detailed/

Description: Get one graph(All details)

6. DELETE - /editor/graph/

Description: Delete one graph

Collection

1. POST - /editor/collection

Description: Create new collection

{
   "name": "Sentosa Mall"
}

2. GET - /editor/collection

Description: Get all collection

3. DELETE - /editor/collection/

Description: Delete one collection

Patrol

1. POST - /editor/patrol

Description: Create new patrol

2. PUT - /editor/patrol/

Description: Update one patrol

{
   "locationID": 1,
   "mapVerID": "b2a546f9-b7a1-4623-8c93-8a574b8db1f6",
   "name": "Patrol",
   "points": ["0", "1", "2", "3", "4", "5", "6"]
}

3. GET - /editor/patrol

Description: Get all patrol routes

4. GET - /editor/patrol/

Description: Get all patrol routes linked to one graph

5. DELETE - /editor/patrol/

Description: Delete one patrol route

Robots

1. GET - /editor/robot

Description: Get all robots available

Tasks

1. POST - /editor/task

Description: Create a task

{
   "type": 1,
   "taskDetails":{
      "mapVerID": "b2a546f9-b7a1-4623-8c93-8a574b8db1f6",
      "locationID": 1,      
      "priority": 1,
      "positionName" : ["0", "1"],
      "timeStamp": "2019-02-28T01:28:51.833977+08:00",
      "robotQuantity": 1,
      "robots": [
         {"id":1,"robotID":"aea55737-cc06-4627-a798-ae2450ea1376"}
      ]
   }
}

{
   "type": 0,
   "taskDetails":{
      "mapVerID": "b2a546f9-b7a1-4623-8c93-8a574b8db1f6",
      "locationID": 1,
      "priority": 1,
      "end": "0",
      "positionName" : ["0", "1"],
      "timeStamp": "2019-02-28T01:28:51.833977+08:00",
      "robotQuantity": 4,
      "robots": [
         {"id":1,"robotID":"aea55737-cc06-4627-a798-ae2450ea1376"},
         {"id":2,"robotID":"278d24bc-c4d2-481f-bd32-9c320ccb3054"},
         {"id":3,"robotID":"1c60248b-80cc-4427-90a6-885ddcf6f8de"},
         {"id":4,"robotID":"d0047237-8bac-473d-8c5e-ebc9f5f2367e"}
      ]
   }
}

Attributes:

• "type": 0 = GOTO/Patrol
• "type": 1 = patrolArea
• "priority": 0 = LOW
• "priority": 1 = MED
• "priority": 2 = HIGH

2. GET - /editor/task

Description: Get all task

3. GET - /editor/task/

Description: Get one task

4. GET - /editor/task/patrol

Description: Get all patrol task

5. GET - /editor/task/goto

Description: Get all goto task

6. DELETE - /editor/task/

Description: Delete one collection

Task Scenarios

Scenario 1:

{
   "robotQuantity": 2,
   "robots": [
      {"id":1,"robotID":"aea55737-cc06-4627-a798-ae2450ea1376"},
      {"id":2,"robotID":"278d24bc-c4d2-481f-bd32-9c320ccb3054"}
   ]
}

Number of unique robots corresponds to robot quantity

Scenario 2:

{
   "robotQuantity": 5,
   "robots": [
      {"id":1,"robotID":"aea55737-cc06-4627-a798-ae2450ea1376"},
      {"id":2,"robotID":"278d24bc-c4d2-481f-bd32-9c320ccb3054"},
      {"id":3,"robotID":"1c60248b-80cc-4427-90a6-885ddcf6f8de"}
   ]
}

Number of unique robots does not match the robot quantity.Traffic Controller has to get other available robots to perform job

Scenario 3:

{
   "robots": [
      {"id":1,"robotID":"aea55737-cc06-4627-a798-ae2450ea1376"},
      {"id":2,"robotID":"278d24bc-c4d2-481f-bd32-9c320ccb3054"}
   ]
}

Only robot IDs are provided