POST_engage_sites_{siteReference}_devicedefaults_{deviceType}

Create Device Type Default Settings

POST /engage/sites/{siteReference}/devicedefaults/{deviceType}

This API creates device default settings for the specified device type in the requested site. The existing default settings for each device type as defined in ENGAGE are used.

Authentication

Basic Authentication, must be a partner managed account type.

URL Parameters

Required:

siteReference = [string]

deviceType = [string]

Data Parameters

None

Success Response:

Code: 200 

Content: 

{"TimeStamp":"636542823615744462","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: Site defaults for specified device type already exists.

Code: 412 Precondition Failed
Content: "The device type already has default settings for the facility."

Scenario: If the site reference is not valid.

Code: 400 Bad request
Content: "Invalid SiteReference."

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

Code: 400 Bad Request
Content: "Invalid Facility Reference.”