Settings

GET /api/v2/gateway/settings [SECURE]

Retrieve settings that are available to change from gateway.

Response

200 OK

{
  "status": 200,
  "returnCode": 13,
  "settings": {
    "zigbeePreset": "A",
    "targetTimeDefault": 350,
    "timezone": "America/New_York"
  }
}

POST /api/v2/gateway/settings [SECURE]

Change any of the available settings.

Body Parameters

Property	Description	Type
zigbeePreset	Presets are constants that involves the zigbee channel, PAN ID, and extended PAN ID. It should not be changed normally unless there are issues where there may be channel conflicts. (e.g. TT starter is on a different RFID channel from gateway)	string
targetTimeDefault	The number of seconds an order being served should reach or finish below to be considered within time. For practical purposes, the time an order is served is the time an order is cleared which means that a good measure of delay should be expected after an order is actually served. This will remain the default value when calling `/api/v2/statistics`	integer default: 300
timezone	Valid timezone or UTC offset.	string

Responses

200 OK

Settings succesfully changed.

{
  "status": 200,
  "returnCode": 1004,
  "message": "Settings successfully changed."
}

400 Bad Request (Invalid Value)

One or more values incorrect in request.

{
  "status": 400,
  "message": "Invalid value DAA for key zigbeePreset. Invalid zigbee preset.",
  "returnCode": -21
}

400 Bad Request (Invalid Settings)

A setting that does not exist was requested to be changed.

{
  "status": 400,
  "message": "Invalid settings key: thisDoesNotExist",
  "returnCode": -20
}