Skip to main content
Skip table of contents

What API do I use to create/update routes?

Route API

Example Request with field name and exact keys:

CODE
{
  "name": "Route 1",
  "isactive": true,
  "routetype": {
    "id": 1234
  },
  "routefrequency": "1",
  "xid": "test-xid",
  "field": {
    "name": "Trial Field"
  }
}

Example with field ID and null values:

CODE
{
  "name": "Route 1",
  "effectiveto": "2050-02-02 00:00:00",
  "isactive": true,
  "code": null,
  "routetype": {
    "name": "RouteType"
  },
  "routefrequency": "1",
  "xid": "test-xid",
  "field": {
    "id": 1234
  },
  "startlocationid": 1234,
  "endlocationid": 1234,
  "contracthourtime": "02:00",
  "scadareadingtime": "02:00",
  "userstring1": null,
  "userstring2": null,
  "userstring3": null,
  "userstring4": null,
  "userstring5": null,
  "userinteger1": null,
  "userinteger2": null,
  "userinteger3": null,
  "userinteger4": null,
  "userinteger5": null,
  "userdecimal1": null,
  "userdecimal2": null,
  "userdecimal3": null,
  "userdecimal4": null,
  "userdecimal5": null,
  "userdatetime1": null,
  "userdatetime2": null,
  "userdatetime3": null,
  "userdatetime4": null,
  "userdatetime5": null
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.