Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
93 lines (68 sloc) 1.84 KB

Virtual Vinli Runs

You can send your Dummy Device on a Dummy Route by creating a Run.

Create a Run

Request

POST https://dummies.vin.li/api/v1/dummies/{dummy_Id}/runs
Content-Type: application/json
{
  "run": {
    "vin": "VVV12912912913456",
    "routeId": "8e90cf47-c6c1-486d-9ba8-194f569c7309"
  }
}

Parameters

  • vin - Required. A made up, 17 digit number that must start with 'VV'
  • routeID - Required. A Dummy Route of your choice
  • repeat - Optional boolean. Defaults to false. If true, will automatically restart the run after completion. If false, will not automatically restart the run.

Response

Get Current Run

Request

GET https://dummies.vin.li/api/v1/dummies/{dummy_Id}/runs/_current
Content-Type: application/json

Response

Delete the Current Run

Request

DELETE https://dummies.vin.li/api/v1/dummies/{dummy_Id}/runs/_current
Content-Type: application/json

Run may take up to 1 minute to delete.