Stormz

Developer


Workshop Canvas

Get a canvas

GET /v1/workshops/:workshop_id/canvas

Response

200 OK
{
  "id": "5007d396eb7abf319a000047",
  "name": "Swot",
  "background": {
    "id": "55507759776865086c000000",
    "cols": 2,
    "rows": 2
  },
  "zones": [
    {
      "id": "5007d396eb7abf319a000047",
      "name": "strength",
      "x": 0,
      "y": 0,
      "rows": 0,
      "cols": 0,
      "cluster_id": "8007d396eb7abf319a000275"
    }
  ]
}

Create a canvas

POST /v1/workshops/:workshop_id/canvas

Parameters

Name Type Description
name string name of the canvas
background.rows float Required number of row taken by the image
background.cols float Required number of col taken by the image
zones.name string Required name of the zone
zones.x float Required x position of the zone
zones.y float Required y position of the zone
zones.rows float Required number of row taken by the zone
zones.cols float Required number of cols taken by the zone

Example

{
  "name": "my canvas",
  "zones": [
    {
      "x": 0,
      "y": 0,
      "rows": 0,
      "cols": 0
    }
  ],
  "image": {
    "cols": 2,
    "rows": 2,
    "url": "http://assets.stormz.me/"
  }
}

Response

201 Created
{
  "id": "5007d396eb7abf319a000047",
  "name": "Swot",
  "background": {
    "id": "55507759776865086c000000",
    "cols": 2,
    "rows": 2
  },
  "zones": [
    {
      "id": "5007d396eb7abf319a000047",
      "name": "strength",
      "x": 0,
      "y": 0,
      "rows": 0,
      "cols": 0,
      "cluster_id": "8007d396eb7abf319a000275"
    }
  ]
}

Delete canvas

DELETE /v1/workshops/:workshop_id/canvas

Response

204 No Content