Create Device Type Default Settings for Site

GET /engage/sites/{siteReference}/devicedefaults

This API creates device default settings for the specified device type in the requested site.

If device default settings exist for a site, this API fetches these settings. If no default settings exist, then it creates default settings and sends them in response.

Authentication

Basic Authentication, must be a partner managed account type.

URL Parameters

Required:

siteReference = [string]

Optional:

deviceType = [string

Data Parameters

None

Success Response:

Code: 200
Content: 

GET response for multiple device types:

{"TimeStamp":"636543491417840775","Defaults":[{"DeviceType":"nde","Settings":[{"Key":"relockDelay","Value":"3"},
{"Key":"adaRelockDelay","Value":"30"},{"Key":"proppedDoorTrigger","Value":"20"},{"Key":"firstPersonIn","Value":"false"},
{"Key":"beeper","Value":"true"},{"Key":"failMode","Value":"Secure"},{"Key":"commFailMode","Value":"AsIs"},
{"Key":"lockType","Value":"Storeroom"},{"Key":"wifiAlertEn","Value":"true"},{"Key":"jagSectors","Value":"4"},
{"Key":"cntrlDecTimeout","Value":"50"},{"Key":"credSecNum","Value":"1"}]},{"DeviceType":"gwe","Settings":[]},
{"DeviceType":"be467","Settings":[{"Key":"relockDelay","Value":"3"},{"Key":"beeper","Value":"true"},
{"Key":"jagSectors","Value":"4"},{"Key":"cntrlDecTimeout","Value":"50"},{"Key":"credSecNum","Value":"1"}]},
{"DeviceType":"fe410","Settings":[{"Key":"relockDelay","Value":"3"},{"Key":"beeper","Value":"true"},
{"Key":"jagSectors","Value":"4"},{"Key":"cntrlDecTimeout","Value":"50"},{"Key":"credSecNum","Value":"1"}]},
{"DeviceType":"lems","Settings":[{"Key":"relockDelay","Value":"3"},{"Key":"adaRelockDelay","Value":"30"},
{"Key":"proppedDoorTrigger","Value":"20"},{"Key":"firstPersonIn","Value":"false"},{"Key":"beeper","Value":"true"},
{"Key":"failMode","Value":"Secure"},{"Key":"commFailMode","Value":"AsIs"},{"Key":"lockType","Value":"Storeroom"},
{"Key":"wifiAlertEn","Value":"true"},{"Key":"blinkIntLed","Value":"0"},{"Key":"jagSectors","Value":"4"},
{"Key":"cntrlDecTimeout","Value":"50"},{"Key":"credSecNum","Value":"1"}]},{"DeviceType":"lemd","Settings":
[{"Key":"relockDelay","Value":"3"},{"Key":"adaRelockDelay","Value":"30"},{"Key":"proppedDoorTrigger","Value":"20"},
{"Key":"firstPersonIn","Value":"false"},{"Key":"beeper","Value":"true"},{"Key":"failMode","Value":"Secure"},
{"Key":"commFailMode","Value":"AsIs"},{"Key":"lockType","Value":"Storeroom"},{"Key":"wifiAlertEn","Value":"true"},
{"Key":"blinkIntLed","Value":"0"},{"Key":"rapidBlink","Value":"0"},{"Key":"jagSectors","Value":"4"},
{"Key":"cntrlDecTimeout","Value":"50"},{"Key":"credSecNum","Value":"1"}]},{"DeviceType":"lemb","Settings":
[{"Key":"relockDelay","Value":"3"},{"Key":"adaRelockDelay","Value":"30"},{"Key":"proppedDoorTrigger","Value":"20"},
{"Key":"firstPersonIn","Value":"false"},{"Key":"beeper","Value":"true"},{"Key":"failMode","Value":"Secure"},
{"Key":"commFailMode","Value":"AsIs"},{"Key":"lockType","Value":"Storeroom"},{"Key":"wifiAlertEn","Value":"true"},
{"Key":"blinkIntLed","Value":"0"},{"Key":"rapidBlink","Value":"0"},{"Key":"jagSectors","Value":"4"},
{"Key":"cntrlDecTimeout","Value":"50"},{"Key":"credSecNum","Value":"1"}]},{"DeviceType":"rmru","Settings":
[{"Key":"proppedDoorTrigger","Value":"20"},{"Key":"dogOnNextExit","Value":"FALSE"},{"Key":"beeper","Value":"TRUE"},
{"Key":"wifiAlertEn","Value":"TRUE"},{"Key":"blinkIntLed","Value":"FALSE"},{"Key":"failMode","Value":"Secure"}]},
{"DeviceType":"cte","Settings":[{"Key":"relockDelay","Value":"3"},{"Key":"adaRelockDelay","Value":"30"},
{"Key":"proppedDoorTrigger","Value":"20"},{"Key":"lockType","Value":"Storeroom"},{"Key":"wifiAlertEn","Value":"true"},
{"Key":"jagSectors","Value":"4"},{"Key":"doorPropEn","Value":"FALSE"},{"Key":"immRelockEn","Value":"FALSE"},
{"Key":"dpsEn","Value":"FALSE"},{"Key":"lineVMain","Value":""},{"Key":"lineVPower","Value":""},
{"Key":"firstPersonIn","Value":"false"}]}]}

GET response for a device type (Example:NDE):

{"TimeStamp":"636543491417840775","Defaults":[{"DeviceType":"nde","Settings":[{"Key":"relockDelay","Value":"3"},
{"Key":"adaRelockDelay","Value":"30"},{"Key":"proppedDoorTrigger","Value":"20"},{"Key":"firstPersonIn","Value":"false"},
{"Key":"beeper","Value":"true"},{"Key":"failMode","Value":"Secure"},{"Key":"commFailMode","Value":"AsIs"},
{"Key":"lockType","Value":"Storeroom"},{"Key":"wifiAlertEn","Value":"true"},{"Key":"jagSectors","Value":"4"},
{"Key":"cntrlDecTimeout","Value":"50"},{"Key":"credSecNum","Value":"1"}]}]}

Error Response:

Scenario: Invalid token or Unauthorized user.

Code: 401 Unauthorized
Content: {"Message": "Authentication failed."}

Scenario: Device type specified in request is not found or invalid i.e. device types which are not included in site defaults feature.

Code: 404 Not Found
Content: "DeviceType not found."

Scenario: If the site reference is not found in the Database.

Code: 404 Not found
Content: "Facility not found.”